Jump to

• Request
• Response

v4.0

get

/ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/shipments/{shipmentId}/eligible-kits

Searches for kits by kit type or shipment details. Rights: OrsInventoryGet, OrsUnblinded. Added additional field kitNumberUTF in the response

Request

Path Parameters

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

  Example:

  test

• shipmentId(required): string(uuid)
  ID of the shipment.

  Example:

  89EE76326E984B548D594D592E5C7FC2

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

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

Query Parameters

• kitTypeId(required): string(uuid)
  ID of the kit type.

  Example:

  9B83BFB48C5A41C59775E4D8D22D8B26

• limit: string
  Maximum number of records to display per page.

  Default Value: 100

  Example:

  100

• offset: string
  An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter.

  Default Value: 0

  Example:

  0

• searchString(required): string
  Search string.

  Example:

  KIT

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ShipmentEligibleKitsResponse

Type: object

Show Source

• count: integer (int64)
  Total count of result
• hasMore: boolean
  Attribute describes if result set has more records

  Example: true
• kits: array kits
  Response object containing kits belonging to shipment.
• limit: integer (int64)
  Maximum number of records to display per page.
• links: array links
• offset: integer (int64)
  An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter.

  Example: 400
• shipmentId: string (uuid)
  Shipment Id.
• totalResults: integer (int64)
  Total number of entities in response

{
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"Shipment Id.",
            "format":"uuid"
        },
        "kits":{
            "type":"array",
            "description":"Response object containing kits belonging to shipment.",
            "example":[
                {
                    "id":"D313327EF13845169A8ADADDA435431E",
                    "kitNumber":1001,
                    "sequenceNumber":1001,
                    "kitTypeName":"Kit A",
                    "expirationDate":"2026-12-31T00:00:00Z",
                    "kitNumberUTF":"KIT-1001",
                    "srcId":"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
                    "lotId":"BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB",
                    "lotNumber":"LOT-001",
                    "quantity":1
                }
            ],
            "items":{
                "$ref":"#/components/schemas/ShipmentEligibleKitTO"
            }
        },
        "count":{
            "type":"integer",
            "description":"Total count of result",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Attribute describes if result set has more records",
            "example":true
        },
        "totalResults":{
            "type":"integer",
            "description":"Total number of entities in response",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "description":"Maximum number of records to display per page.",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "description":"An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter.",
            "format":"int64",
            "example":400
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelLink"
            }
        }
    }
}

Nested Schema : kits

Type: array

Response object containing kits belonging to shipment.

Show Source

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

  Contains kit details belonging to shipment.

{
    "type":"array",
    "description":"Response object containing kits belonging to shipment.",
    "example":[
        {
            "id":"D313327EF13845169A8ADADDA435431E",
            "kitNumber":1001,
            "sequenceNumber":1001,
            "kitTypeName":"Kit A",
            "expirationDate":"2026-12-31T00:00:00Z",
            "kitNumberUTF":"KIT-1001",
            "srcId":"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
            "lotId":"BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB",
            "lotNumber":"LOT-001",
            "quantity":1
        }
    ],
    "items":{
        "$ref":"#/components/schemas/ShipmentEligibleKitTO"
    }
}

Example:

[
    {
        "id":"D313327EF13845169A8ADADDA435431E",
        "kitNumber":1001,
        "sequenceNumber":1001,
        "kitTypeName":"Kit A",
        "expirationDate":"2026-12-31T00:00:00Z",
        "kitNumberUTF":"KIT-1001",
        "srcId":"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
        "lotId":"BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB",
        "lotNumber":"LOT-001",
        "quantity":1
    }
]

Nested Schema : links

Type: array

Show Source

• Array of: object RelLink
  Object contains link detail.

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

Nested Schema : ShipmentEligibleKitTO v1.0

Type: object

Title: ShipmentEligibleKitTO v1.0

Contains kit details belonging to shipment.

Show Source

• expirationDate: string (date-time)
  Expiration date.

  Example: 2025-05-09T00:00:00Z
• id: string (uuid)
  Inventory ID.
• kitNumber: number (double)
  Kit/Lot number.

  Example: 5
• kitNumberUTF: string
  Kit number in UTF-8 format.

  Example: 12345ab
• kitTypeName: string
  Kit type name.

  Example: Kit A
• lotId: string (uuid)
  ID of the lot.
• lotNumber: string
  Manufacturing lot number.

  Example: 12345ab
• quantity: number (double)
  Quantity of kits.

  Example: 5
• sequenceNumber: number (double)
  Sequence number.

  Example: 5
• srcId: string (uuid)
  Kit type source ID.

{
    "title":"ShipmentEligibleKitTO v1.0",
    "type":"object",
    "properties":{
        "kitNumber":{
            "type":"number",
            "description":"Kit/Lot number.",
            "format":"double",
            "example":5
        },
        "sequenceNumber":{
            "type":"number",
            "description":"Sequence number.",
            "format":"double",
            "example":5
        },
        "kitTypeName":{
            "type":"string",
            "description":"Kit type name.",
            "example":"Kit A"
        },
        "expirationDate":{
            "type":"string",
            "description":"Expiration date.",
            "format":"date-time",
            "example":"2025-05-09T00:00:00Z"
        },
        "srcId":{
            "type":"string",
            "description":"Kit type source ID.",
            "format":"uuid"
        },
        "lotId":{
            "type":"string",
            "description":"ID of the lot.",
            "format":"uuid"
        },
        "quantity":{
            "type":"number",
            "description":"Quantity of kits.",
            "format":"double",
            "example":5
        },
        "id":{
            "type":"string",
            "description":"Inventory ID.",
            "format":"uuid"
        },
        "kitNumberUTF":{
            "type":"string",
            "description":"Kit number in UTF-8 format.",
            "example":"12345ab"
        },
        "lotNumber":{
            "type":"string",
            "description":"Manufacturing lot number.",
            "example":"12345ab"
        }
    },
    "description":"Contains kit details belonging to shipment.",
    "example":{
        "id":"D313327EF13845169A8ADADDA435431E",
        "kitNumber":1001,
        "sequenceNumber":1001,
        "kitTypeName":"Kit A",
        "expirationDate":"2026-12-31T00:00:00Z",
        "kitNumberUTF":"KIT-1001",
        "srcId":"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
        "lotId":"BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB",
        "lotNumber":"LOT-001",
        "quantity":1
    }
}

Example:

{
    "id":"D313327EF13845169A8ADADDA435431E",
    "kitNumber":1001,
    "sequenceNumber":1001,
    "kitTypeName":"Kit A",
    "expirationDate":"2026-12-31T00:00:00Z",
    "kitNumberUTF":"KIT-1001",
    "srcId":"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
    "lotId":"BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB",
    "lotNumber":"LOT-001",
    "quantity":1
}

Nested Schema : RelLink

Type: object

Object contains link detail.

Show Source

• href: string
  Realtive URL
• rel: string
  link

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"link"
        },
        "href":{
            "type":"string",
            "description":"Realtive URL"
        }
    },
    "description":"Object contains link detail."
}

Examples

Select an example Get Eligible Kits Response

404 Response

'Invalid study ID', 'Study still in design phase' or 'Invalid shipment ID'

Body ()

Root Schema : DesignerResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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

Nested Schema : details

Type: object

Examples

Select an example Get Eligible Kits Not Found Response

500 Response

Internal server error

Body ()

Root Schema : DesignerResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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

Nested Schema : details

Type: object

Examples

Select an example Get Eligible Kits Server Error Response

Back to Top