Jump to

• Request
• Response

Get kits from depot inventory by depot ID

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
• mode(required): string
  Mode of the study, accepts: test, active, or training.
• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

Query Parameters

• blindedLotId: string(uuid)
  blindedLotId for search
• inventoryStatusId: array[integer]
  A list of IDs of the inventory status
• kitNumberMax: number
  Minumum Kit Number for search
• kitNumberMin: number
  Minumum Kit Number for search
• limit: integer(int32)
  Maximum number of records to display per page.

  Default Value: 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
• quarantineId: string
  quarantineId for search
• searchByKitNumber: string
  Kit Number Search string
• searchBySeqNumber: number
  Sequence Number Search Number
• sequenceNumberMax: number
  Maximum Sequence search Number
• sequenceNumberMin: number
  Minumum Sequence search Number
• shipmentNumber: string
  shipmentNumber for search

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : SiteKitDetailsResponseV1

Type: object

Title: SiteKitDetailsResponseV1

Contains site kit detail.

Show Source

• blindedLotsExistsInStudy: boolean
  blindedLotsExistsInStudy.

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

  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).
• hasMore: boolean
  Attribute describes if result set has more records

  Example: true
• kits: array kits
  Title: kits

  Kit reconcile detail.
• 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":"SiteKitDetailsResponseV1",
    "type":"object",
    "properties":{
        "distinctInventoryStatusIds":{
            "title":"distinctInventoryStatusIds",
            "type":"array",
            "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,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":{
            "type":"boolean",
            "description":"blindedLotsExistsInStudy.",
            "example":true
        },
        "kits":{
            "title":"kits",
            "type":"array",
            "description":"Kit reconcile detail.",
            "items":{
                "$ref":"#/components/schemas/DepotUserKitReconciliationTO"
            }
        },
        "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 site kit detail."
}

Nested Schema : distinctInventoryStatusIds

Type: array

Title: distinctInventoryStatusIds

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).

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":"distinctInventoryStatusIds",
    "type":"array",
    "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,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

Kit reconcile detail.

Show Source

• Array of: object DepotUserKitReconciliationTO

{
    "title":"kits",
    "type":"array",
    "description":"Kit reconcile detail.",
    "items":{
        "$ref":"#/components/schemas/DepotUserKitReconciliationTO"
    }
}

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

Type: object

Show Source

• barCode: string
  barCode

  Example: BarCode
• blindedLotExpirationDate: string (date-time)
  Blinded lot expiration date
• blindedLotId: string
  blinded lot id

  Example: B1B8327AFAA6412287106192AB5984EF
• blindedLotNumber: string
  blinded lot number

  Example: blot1
• blockNumber: string
  blockNumber
• distributionSetting: string
  Allowed Values: [ "BLINDED", "UNBLINDED" ]

  Distribution setting
• 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" ]

  Inventory status

  Example: New, Damaged
• inventoryStatusId: number (int)
  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
  kitDescription
• kitNumberUTF: string
  kitNumberUTF

  Example: 5
• labelGroup: string
  label group

  Example: labelGroup1
• labelGroupId: string
  label group id

  Example: 10000000000000000000000000000001
• manufacturingLotId: string
  manufacturing lot id

  Example: B1B8327AFAA6412287106192AB5984EF
• manufacturingLotNumber: string
  manufacture lot number

  Example: Lot1
• quantity: number (int)
  kit quantity

  Example: 5
• restrictedQuantity: number (int)
  restricted quantity

  Example: 1
• sequenceNumber: number (BigDecimal)
  sequenceNumber
• unitsPerKit: number (BigDecimal)
  unitsPerKit

{
    "type":"object",
    "properties":{
        "kitNumberUTF":{
            "type":"string",
            "description":"kitNumberUTF",
            "example":"5"
        },
        "sequenceNumber":{
            "type":"number",
            "description":"sequenceNumber",
            "format":"BigDecimal"
        },
        "blockNumber":{
            "type":"string",
            "description":"blockNumber"
        },
        "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).",
            "format":"int",
            "example":5
        },
        "inventoryStatus":{
            "type":"string",
            "description":"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":"unitsPerKit",
            "format":"BigDecimal"
        },
        "kitDescription":{
            "type":"string",
            "description":"kitDescription"
        },
        "distributionSetting":{
            "type":"string",
            "description":"Distribution setting",
            "enum":[
                "BLINDED",
                "UNBLINDED"
            ]
        },
        "barCode":{
            "type":"string",
            "description":"barCode",
            "example":"BarCode"
        },
        "blindedLotExpirationDate":{
            "type":"string",
            "description":"Blinded lot expiration date",
            "format":"date-time"
        },
        "blindedLotId":{
            "type":"string",
            "description":"blinded lot id",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "labelGroupId":{
            "type":"string",
            "description":"label group id",
            "example":"10000000000000000000000000000001"
        },
        "manufacturingLotNumber":{
            "type":"string",
            "description":"manufacture lot number",
            "example":"Lot1"
        },
        "blindedLotNumber":{
            "type":"string",
            "description":"blinded lot number",
            "example":"blot1"
        },
        "labelGroup":{
            "type":"string",
            "description":"label group",
            "example":"labelGroup1"
        },
        "quantity":{
            "type":"number",
            "description":"kit quantity",
            "format":"int",
            "example":5
        },
        "restrictedQuantity":{
            "type":"number",
            "description":"restricted quantity",
            "format":"int",
            "example":1
        },
        "id":{
            "type":"string",
            "description":"Inventory Id",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "manufacturingLotId":{
            "type":"string",
            "description":"manufacturing lot id",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        }
    }
}

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."
}

400 Response

For invalid kit range format

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• 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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

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
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• 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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• 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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

Back to Top