Jump to

• Request
• Response

v1.0

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/depots/{depotId}/inventory/kits

Retrieves a list of inventories based on the filters passed in the request. Rights: ORSBlindedDepotGet, returns list of inventories at the depot for the passed filters.

Request

Path Parameters

• depotId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical depot

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

• 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

Query Parameters

• blindedLotId: string(uuid)
  Blinded lot ID for search

  Example:

  B1B8327AFAA6412287106192AB5984EF

• inventoryStatusId: array[integer]
  List of inventory status IDs.

  Example:

  5

• kitNumberMax: number
  Maximum kit number for search

  Example:

  10100

• kitNumberMin: number
  Minimum kit number for search

  Example:

  10001

• limit: integer(int32)
  Maximum number of records to display per page.

  Default Value: 100

  Example:

  100

• offset: integer(int32)
  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

• quarantineId: string
  Quarantine ID for search

  Example:

  Q-0001

• searchByKitNumber: string
  Kit Number search string.

  Example:

  KIT-0001

• searchBySeqNumber: number
  Sequence number search string.

  Example:

  1

• sequenceNumberMax: number
  Maximum sequence number for search

  Example:

  100

• sequenceNumberMin: number
  Minimum sequence number for search

  Example:

  1

• shipmentNumber: string
  Shipment number for search

  Example:

  SHIP-0001

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : DepotKitDetailsResponse v1.0

Type: object

Title: DepotKitDetailsResponse v1.0

Contains depot kit details.

Show Source

• blindedLotsExistsInStudy: boolean
  Title: Blinded Lots Exist In Study

  Indicates whether blinded lots exist in the study.

  Example: true
• count: integer (int64)
  Total count of result
• distinctInventoryStatusIds: array Inventory Status IDs
  Title: Inventory Status IDs

  Inventory status IDs.
• hasMore: boolean
  Attribute describes if result set has more records

  Example: true
• kits: array Kits
  Title: Kits

  Depot user kit reconciliation details.
• 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
• totalResults: integer (int64)
  Total number of entities in response

{
    "title":"DepotKitDetailsResponse v1.0",
    "type":"object",
    "properties":{
        "distinctInventoryStatusIds":{
            "title":"Inventory Status IDs",
            "type":"array",
            "description":"Inventory status IDs.",
            "example":"5,4",
            "items":{
                "type":"integer",
                "format":"int32"
            },
            "enum":[
                "1",
                "2",
                "3",
                "4",
                "5",
                "6",
                "7",
                "8",
                "9",
                "10",
                "11",
                "12",
                "13",
                "14",
                "15",
                "16",
                "17",
                "18",
                "19",
                "20"
            ]
        },
        "blindedLotsExistsInStudy":{
            "title":"Blinded Lots Exist In Study",
            "type":"boolean",
            "description":"Indicates whether blinded lots exist in the study.",
            "example":true
        },
        "kits":{
            "title":"Kits",
            "type":"array",
            "description":"Depot user kit reconciliation details.",
            "example":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EF",
                    "kitNumberUTF":"10001",
                    "sequenceNumber":1,
                    "blockNumber":"BLK-001",
                    "inventoryStatusId":5,
                    "inventoryStatus":"Available",
                    "unitsPerKit":30,
                    "kitDescription":"Bottle of tablets",
                    "distributionSetting":"BLINDED",
                    "barCode":"BAR-10001",
                    "blindedLotExpirationDate":"2026-12-31T00:00:00Z"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/DepotUserKitReconciliationTOV1"
            }
        },
        "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"
            }
        }
    },
    "description":"Contains depot kit details."
}

Nested Schema : Inventory Status IDs

Type: array

Title: Inventory Status IDs

Inventory status IDs.

Allowed Values: [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20" ]

Show Source

• Array of: integer(int32)

{
    "title":"Inventory Status IDs",
    "type":"array",
    "description":"Inventory status IDs.",
    "example":"5,4",
    "items":{
        "type":"integer",
        "format":"int32"
    },
    "enum":[
        "1",
        "2",
        "3",
        "4",
        "5",
        "6",
        "7",
        "8",
        "9",
        "10",
        "11",
        "12",
        "13",
        "14",
        "15",
        "16",
        "17",
        "18",
        "19",
        "20"
    ]
}

Example:

5,4

Nested Schema : Kits

Type: array

Title: Kits

Depot user kit reconciliation details.

Show Source

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

  Depot user kit reconciliation details.

{
    "title":"Kits",
    "type":"array",
    "description":"Depot user kit reconciliation details.",
    "example":[
        {
            "id":"B1B8327AFAA6412287106192AB5984EF",
            "kitNumberUTF":"10001",
            "sequenceNumber":1,
            "blockNumber":"BLK-001",
            "inventoryStatusId":5,
            "inventoryStatus":"Available",
            "unitsPerKit":30,
            "kitDescription":"Bottle of tablets",
            "distributionSetting":"BLINDED",
            "barCode":"BAR-10001",
            "blindedLotExpirationDate":"2026-12-31T00:00:00Z"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/DepotUserKitReconciliationTOV1"
    }
}

Example:

[
    {
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "kitNumberUTF":"10001",
        "sequenceNumber":1,
        "blockNumber":"BLK-001",
        "inventoryStatusId":5,
        "inventoryStatus":"Available",
        "unitsPerKit":30,
        "kitDescription":"Bottle of tablets",
        "distributionSetting":"BLINDED",
        "barCode":"BAR-10001",
        "blindedLotExpirationDate":"2026-12-31T00:00:00Z"
    }
]

Nested Schema : links

Type: array

Show Source

• Array of: object RelLink
  Object contains link detail.

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

Nested Schema : DepotUserKitReconciliationTO v1.0

Type: object

Title: DepotUserKitReconciliationTO v1.0

Depot user kit reconciliation details.

Show Source

• barCode: string
  Barcode.

  Example: BarCode
• blindedLotExpirationDate: string (date-time)
  Blinded lot expiration date.

  Example: 2026-12-31T00:00:00Z
• blockNumber: string
  Title: Block Number

  Block number.

  Example: BLK-001
• distributionSetting: string
  Allowed Values: [ "BLINDED", "UNBLINDED" ]

  Distribution setting

  Example: BLINDED
• id: string
  Inventory ID.

  Example: B1B8327AFAA6412287106192AB5984EF
• inventoryStatus: string
  Allowed Values: [ "Available", " Damaged", " Destroyed", " Dispensed", " Expired", " Not in Use", " Misallocated", " Missing", " In Transit", " Quarantined", " Pre-quarantined", " Pending Destruction", " Lost by Subject", " Temporarily Unavailable", " Damaged by Subject", " New", " Not Dispensed to Subject", " Returned to Site" ]

  Name of the inventory status.

  Example: New, Damaged
• inventoryStatusId: number
  Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).

  Example: 5
• kitDescription: string
  Kit description.

  Example: Bottle of tablets
• kitNumberUTF: string
  Title: Kit Number UTF

  Kit number with UTF-8 support.

  Example: 5
• sequenceNumber: number
  Sequence number.

  Example: 1
• unitsPerKit: number
  Units per kit.

  Example: 30

{
    "title":"DepotUserKitReconciliationTO v1.0",
    "type":"object",
    "properties":{
        "kitNumberUTF":{
            "title":"Kit Number UTF",
            "type":"string",
            "description":"Kit number with UTF-8 support.",
            "example":"5"
        },
        "sequenceNumber":{
            "type":"number",
            "description":"Sequence number.",
            "example":1
        },
        "blockNumber":{
            "title":"Block Number",
            "type":"string",
            "description":"Block number.",
            "example":"BLK-001"
        },
        "inventoryStatusId":{
            "type":"number",
            "description":"Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).",
            "example":5
        },
        "inventoryStatus":{
            "type":"string",
            "description":"Name of the inventory status.",
            "example":"New, Damaged",
            "enum":[
                "Available",
                " Damaged",
                " Destroyed",
                " Dispensed",
                " Expired",
                " Not in Use",
                " Misallocated",
                " Missing",
                " In Transit",
                " Quarantined",
                " Pre-quarantined",
                " Pending Destruction",
                " Lost by Subject",
                " Temporarily Unavailable",
                " Damaged by Subject",
                " New",
                " Not Dispensed to Subject",
                " Returned to Site"
            ]
        },
        "unitsPerKit":{
            "type":"number",
            "description":"Units per kit.",
            "example":30
        },
        "kitDescription":{
            "type":"string",
            "description":"Kit description.",
            "example":"Bottle of tablets"
        },
        "distributionSetting":{
            "type":"string",
            "description":"Distribution setting",
            "example":"BLINDED",
            "enum":[
                "BLINDED",
                "UNBLINDED"
            ]
        },
        "barCode":{
            "type":"string",
            "description":"Barcode.",
            "example":"BarCode"
        },
        "blindedLotExpirationDate":{
            "type":"string",
            "description":"Blinded lot expiration date.",
            "format":"date-time",
            "example":"2026-12-31T00:00:00Z"
        },
        "id":{
            "type":"string",
            "description":"Inventory ID.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        }
    },
    "description":"Depot user kit reconciliation details.",
    "example":{
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "kitNumberUTF":"10001",
        "sequenceNumber":1,
        "blockNumber":"BLK-001",
        "inventoryStatusId":5,
        "inventoryStatus":"Available",
        "unitsPerKit":30,
        "kitDescription":"Bottle of tablets",
        "distributionSetting":"BLINDED",
        "barCode":"BAR-10001",
        "blindedLotExpirationDate":"2026-12-31T00:00:00Z"
    }
}

Example:

{
    "id":"B1B8327AFAA6412287106192AB5984EF",
    "kitNumberUTF":"10001",
    "sequenceNumber":1,
    "blockNumber":"BLK-001",
    "inventoryStatusId":5,
    "inventoryStatus":"Available",
    "unitsPerKit":30,
    "kitDescription":"Bottle of tablets",
    "distributionSetting":"BLINDED",
    "barCode":"BAR-10001",
    "blindedLotExpirationDate":"2026-12-31T00:00:00Z"
}

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 Depot Kits Response

400 Response

For invalid kit range format

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 Depot Kits Bad Request Response

404 Response

For invalid study ID OR study still in design phase OR invalid depot ID OR invalid subject ID

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 Depot Kits Not Found 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 Depot Kits Server Error Response

Back to Top