REST API for Clinical One Platform

Get kit summary by kit type ID

get

/ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/inventory/kit-types/{kitTypeId}/kits

Retrieves kit summary by kit type ID with new Column : TempExcursionNumber. Rights: OrsInventoryGet and OrsUnblinded.

Request

Path Parameters

kitTypeId(required): string

ID of the kit type.
mode(required): string

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

ID of the study

Query Parameters

blockNumber: string

Block number
kitNumber: string

Kit number
kitRange(required): string

Range of the kit
kitStatus(required): string

Status of the kit
labelGroupId(required): string

ID of the label group
limit: string

Maximum number of records to display per page.
location(required): string

Location of the kit
lotId(required): string

ID of the lot
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. Offset is affected by the value of the order parameter
sortBy: string

Specify the parameter by which the kits are ordered. Default valus is 'SEQUENCE_NUMBER'

Default Value: SEQUENCE_NUMBER
tempExcursionNumber: string

tempExcursionNumber

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : KitDetailsResponse

Type: object

Contains kit detail response.

Show Source

count: integer (int64)

Total count of result
hasMore: boolean

Attribute describes if result set has more records

Example: true
kits: array kits
kitTypeId: string

Kit type id

Example: B1B8327AFAA6412287106192AB5984EF
kitTypeName: string

Kit type name

Example: Kit1001
limit: integer (int64)

Maximum number of records to display per page.
links: array links
maxKitNumber: integer (int32)

Maximum Kit number

Example: 5
maxSequenceNumber: integer (int32)

Kit maximum sequence number

Example: 5
minKitNumber: integer (int32)

Minimum Kit number

Example: 5
minSequenceNumber: integer (int32)

Kit minimum sequence number

Example: 5
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

{
    "type":"object",
    "properties":{
        "kitTypeId":{
            "type":"string",
            "description":"Kit type id",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "kitTypeName":{
            "type":"string",
            "description":"Kit type name",
            "example":"Kit1001"
        },
        "minKitNumber":{
            "type":"integer",
            "description":"Minimum Kit number",
            "format":"int32",
            "example":"5"
        },
        "maxKitNumber":{
            "type":"integer",
            "description":"Maximum Kit number",
            "format":"int32",
            "example":"5"
        },
        "minSequenceNumber":{
            "type":"integer",
            "description":"Kit minimum sequence number",
            "format":"int32",
            "example":"5"
        },
        "maxSequenceNumber":{
            "type":"integer",
            "description":"Kit maximum sequence number",
            "format":"int32",
            "example":"5"
        },
        "kits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KitDetailsTO"
            }
        },
        "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 kit detail response."
}

Nested Schema : kits

Type: array

Show Source

Array of: object KitDetailsTO

Title: KitDetailsTO

Contains kit detail.

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

Nested Schema : links

Type: array

Show Source

Array of: object RelLink

Object contains link detail.

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

Nested Schema : KitDetailsTO

Type: object

Title: KitDetailsTO

Contains kit detail.

Show Source

blindedLotId: string

Blinded lot id

Example: 9BD49A59E47E4383B98802712763FD43
blindedLotNumber: string

Blinded lot number

Example: BLot1101
inventoryId: string (uuid)

Unique id for inventory
inventoryStatus: string

Inventory status

Example: Dispensed
inventoryStatusId: number (BigDecimal)

Inventory status id

Example: 10
kitNumber: number (BigDecimal)

Kit number.

Example: 10
labelGroup: string

Label group

Example: Labelgroup1001
labelGroupId: string

Label group id

Example: 9BD49A59E47E4383B98802712763FD43
locationId: string

Location id

Example: 1873CDF69E9B48B89B2D9E7951057D09
manufacturingLotId: string

Manufactoring lot id

Example: 9BD49A59E47E4383B98802712763FD43
manufacturingLotNumber: string

Manufactoring lot number

Example: Mlot1001
sequenceNumber: number (BigDecimal)

Sequence number

Example: 10

{
    "title":"KitDetailsTO",
    "type":"object",
    "properties":{
        "kitNumber":{
            "type":"number",
            "description":"Kit number.",
            "format":"BigDecimal",
            "example":"10"
        },
        "sequenceNumber":{
            "type":"number",
            "description":"Sequence number",
            "format":"BigDecimal",
            "example":"10"
        },
        "inventoryStatusId":{
            "type":"number",
            "description":"Inventory status id",
            "format":"BigDecimal",
            "example":"10"
        },
        "locationId":{
            "type":"string",
            "description":"Location id",
            "example":"1873CDF69E9B48B89B2D9E7951057D09"
        },
        "manufacturingLotId":{
            "type":"string",
            "description":"Manufactoring lot id",
            "example":"9BD49A59E47E4383B98802712763FD43"
        },
        "blindedLotId":{
            "type":"string",
            "description":"Blinded lot id",
            "example":"9BD49A59E47E4383B98802712763FD43"
        },
        "labelGroupId":{
            "type":"string",
            "description":"Label group id",
            "example":"9BD49A59E47E4383B98802712763FD43"
        },
        "inventoryStatus":{
            "type":"string",
            "description":"Inventory status",
            "example":"Dispensed"
        },
        "manufacturingLotNumber":{
            "type":"string",
            "description":"Manufactoring lot number",
            "example":"Mlot1001"
        },
        "blindedLotNumber":{
            "type":"string",
            "description":"Blinded lot number",
            "example":"BLot1101"
        },
        "labelGroup":{
            "type":"string",
            "description":"Label group",
            "example":"Labelgroup1001"
        },
        "inventoryId":{
            "type":"string",
            "description":"Unique id for inventory",
            "format":"uuid"
        }
    },
    "description":"Contains kit detail."
}

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

Invalid kit status OR Invalid kit range filter OR Invalid label group in kit filtersOR Invalid kit type OR Invalid Lot OR Invalid location

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

Invalid study ID or version or Kit type not found

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