REST API for Clinical One Cloud Service

v8.0

get

/ec-ors-svc/rest/v8.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits

Retrieves kits for a site based on a given number range and filters kits as serialized or non-serialized. Kit Range should be specified in the format as KIT_NUMBER:{From Kit number}:{To Kit number}. e.g. KIT_NUMBER:1:100.
Rights: OrsInventoryGet and either OrsUnblinded or OrsBlinded.

Request

Path Parameters

mode(required): string
Indicates the operational mode of the study. Accepted values: active, test, or training.
Example:
```
test
```
siteId(required): string(uuid)
Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.
Example:
```
B1B8327AFAA6412287106192AB5984EF
```
studyId(required): string(uuid)
Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.
Example:
```
B1B8327AFAA6412287106192AB5984EF
```

Query Parameters

inventoryStatusId(required): array[integer]
List of inventory status IDs.
Example:
```
10
```
kitRange(required): string
Range of the kit.
Example:
```
KIT_NUMBER:10:100
```
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
```
serialized: boolean
Serialized
Example:
```
true
```
subjectId(required): string(uuid)
Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.
Example:
```
C36A3197FDEE433FB5547EE83DE99E4B
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : Site Kit Details Response

Type: object

Title: Site Kit Details Response

Contains site kit detail.

Show Source

count: integer (int64)

Total count of result
hasMore: boolean

Attribute describes if result set has more records

Example: true
kits: array Kits

Title: Kits

Contains site user inventory.
limit: integer (int64)

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

Title: Maximum Kit Number

Maximum Kit number.

Example: 10
minKitNumber: integer (int32)

Title: Minimum Kit Number

Minimum Kit number.

Example: 10
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":"Site Kit Details Response",
    "type":"object",
    "properties":{
        "minKitNumber":{
            "title":"Minimum Kit Number",
            "type":"integer",
            "description":"Minimum Kit number.",
            "format":"int32",
            "example":10
        },
        "maxKitNumber":{
            "title":"Maximum Kit Number",
            "type":"integer",
            "description":"Maximum Kit number.",
            "format":"int32",
            "example":10
        },
        "kits":{
            "title":"Kits",
            "type":"array",
            "description":"Contains site user inventory.",
            "example":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EF",
                    "kitNumber":10001,
                    "inventoryStatusId":10,
                    "inventoryStatus":"Dispensed",
                    "shipmentId":"C36A3197FDEE433FB5547EE83DE99E4B",
                    "shipmentNumber":"SHIP-0001",
                    "receivedDate":"2026-02-21T23:36:32.079Z",
                    "comment":"Received at site"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/SiteUserInventoryTO"
            }
        },
        "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 : Kits

Type: array

Title: Kits

Contains site user inventory.

Show Source

Array of: object SiteUserInventoryTO

Title: SiteUserInventoryTO

Contains site inventory detail.

{
    "title":"Kits",
    "type":"array",
    "description":"Contains site user inventory.",
    "example":[
        {
            "id":"B1B8327AFAA6412287106192AB5984EF",
            "kitNumber":10001,
            "inventoryStatusId":10,
            "inventoryStatus":"Dispensed",
            "shipmentId":"C36A3197FDEE433FB5547EE83DE99E4B",
            "shipmentNumber":"SHIP-0001",
            "receivedDate":"2026-02-21T23:36:32.079Z",
            "comment":"Received at site"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/SiteUserInventoryTO"
    }
}

Example:

[
    {
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "kitNumber":10001,
        "inventoryStatusId":10,
        "inventoryStatus":"Dispensed",
        "shipmentId":"C36A3197FDEE433FB5547EE83DE99E4B",
        "shipmentNumber":"SHIP-0001",
        "receivedDate":"2026-02-21T23:36:32.079Z",
        "comment":"Received at site"
    }
]

Nested Schema : links

Type: array

Show Source

Array of: object RelLink

Object contains link detail.

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

Nested Schema : SiteUserInventoryTO

Type: object

Title: SiteUserInventoryTO

Contains site inventory detail.

Show Source

comment: string

Title: Comment

Comment for shipment.

Example: Some description
id: string (uuid)

Title: Inventory ID

Unique ID for inventory.
inventoryStatus: string

Title: Inventory Status

Inventory status.

Example: Dispensed
inventoryStatusId: integer (int32)

Title: Inventory Status ID

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

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: 10
kitNumber: number (double)

Title: Kit Number

Kit/Lot number.

Example: 10
receivedDate: string (date-time)

Title: Received Date

Shipment received date.

Example: 2016-11-14T23:36:32.079Z
shipmentId: string (uuid)

Title: Shipment ID

Order (shipment) ID.
shipmentNumber: string

Title: Shipment Number

Shipment number.

Example: 12345

{
    "title":"SiteUserInventoryTO",
    "type":"object",
    "properties":{
        "kitNumber":{
            "title":"Kit Number",
            "type":"number",
            "description":"Kit/Lot number.",
            "format":"double",
            "example":10
        },
        "inventoryStatusId":{
            "title":"Inventory Status ID",
            "type":"integer",
            "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":"int32",
            "example":10,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10,
                11,
                12,
                13,
                14,
                15,
                16,
                17,
                18,
                19,
                20
            ]
        },
        "inventoryStatus":{
            "title":"Inventory Status",
            "type":"string",
            "description":"Inventory status.",
            "example":"Dispensed"
        },
        "shipmentNumber":{
            "title":"Shipment Number",
            "type":"string",
            "description":"Shipment number.",
            "example":"12345"
        },
        "receivedDate":{
            "title":"Received Date",
            "type":"string",
            "description":"Shipment received date.",
            "format":"date-time",
            "example":"2016-11-14T23:36:32.079Z"
        },
        "comment":{
            "title":"Comment",
            "type":"string",
            "description":"Comment for shipment.",
            "example":"Some description"
        },
        "id":{
            "title":"Inventory ID",
            "type":"string",
            "description":"Unique ID for inventory.",
            "format":"uuid"
        },
        "shipmentId":{
            "title":"Shipment ID",
            "type":"string",
            "description":"Order (shipment) ID.",
            "format":"uuid"
        }
    },
    "description":"Contains site inventory detail.",
    "example":{
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "kitNumber":10001,
        "inventoryStatusId":10,
        "inventoryStatus":"Dispensed",
        "shipmentId":"C36A3197FDEE433FB5547EE83DE99E4B",
        "shipmentNumber":"SHIP-0001",
        "receivedDate":"2026-02-21T23:36:32.079Z",
        "comment":"Received at site"
    }
}

Example:

{
    "id":"B1B8327AFAA6412287106192AB5984EF",
    "kitNumber":10001,
    "inventoryStatusId":10,
    "inventoryStatus":"Dispensed",
    "shipmentId":"C36A3197FDEE433FB5547EE83DE99E4B",
    "shipmentNumber":"SHIP-0001",
    "receivedDate":"2026-02-21T23:36:32.079Z",
    "comment":"Received at site"
}

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

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

Examples

404 Response

For invalid study ID OR study still in design phase OR invalid site 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

Examples

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

Examples