Jump to

• Request
• Response

v1.0

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kitlists

Retrieves generated/uploaded kit lists details in a study. Rights: OrsInventoryGet.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object KitListDetailsTO v1.0
  Title: KitListDetailsTO v1.0

  Object containing kit list details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/KitListDetailsTOV1"
    }
}

Nested Schema : KitListDetailsTO v1.0

Type: object

Title: KitListDetailsTO v1.0

Object containing kit list details.

Show Source

• description: string
  Title: Description

  Kit list description.

  Example: Example kit list.
• id: string (uuid)
  Title: ID

  Unique identifier of the kit list.
• name: string
  Title: Name

  Kit list name.

  Example: KitList-01
• statusId: integer (int32)
  Title: Status ID

  Status ID of the kit list.

  Example: 1

{
    "title":"KitListDetailsTO v1.0",
    "type":"object",
    "properties":{
        "id":{
            "title":"ID",
            "type":"string",
            "description":"Unique identifier of the kit list.",
            "format":"uuid"
        },
        "name":{
            "title":"Name",
            "type":"string",
            "description":"Kit list name.",
            "example":"KitList-01"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "description":"Kit list description.",
            "example":"Example kit list."
        },
        "statusId":{
            "title":"Status ID",
            "type":"integer",
            "description":"Status ID of the kit list.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Object containing kit list details."
}

Examples

Select an example Get Kit Lists Details Response

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

Examples

Select an example Get Kit Lists Details Server Error Response

Back to Top