REST API for Clinical One Platform

Get depot inventory

get

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

Retrieves a list of serialized and/or non-serialized kits on a depot inventory, based on the filters passed in the request.
Rights: ORSBlindedDepotGet

Request

Path Parameters

depotId(required): string(uuid)

ID of the depot
mode(required): string

Mode of the study, accepts: test, active, or training
studyId(required): string(uuid)

ID of 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. Offset is affected by the value of the order 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
serialized: boolean

is kit serialized or non-serialized
shipmentNumber: string

shipmentNumber for search

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

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. Offset is affected by the value of the order 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. Offset is affected by the value of the order 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
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
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"
        },
        "id":{
            "type":"string",
            "description":"Inventory 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

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

404 Response

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

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

500 Response

Internal server error

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