1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Randomization and Supplies
  4. Inventory APIs
  5. Search for kits in a given range for a site

[Deprecated]: v2.0
get

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

Deprecated:

Request

Path Parameters
Query Parameters
  • List of inventory status IDs.
    Example:
    [
    5,
    10
]
  • Range of the kit.
    Example:
    KIT_NUMBER:10:100
  • Maximum number of records to display per page.
    Default Value: 100
    Example:
    100
  • 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
  • Search string.
    Example:
    KIT
  • 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:
    B1B8327AFAA6412287106192AB5984EF

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : Site Kit Details Response v2.0
Type: object
Title: Site Kit Details Response v2.0
Contains site kit detail.
Show Source
Nested Schema : Distinct Inventory Status IDs
Type: array
Title: Distinct Inventory Status IDs
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
Example:
[
    5,
    4
]
Nested Schema : Kits
Type: array
Title: Kits
Contains site user inventory.
Show Source
Example:
[
    {
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "kitNumber":123,
        "inventoryStatusId":5,
        "inventoryStatus":"Available",
        "shipmentId":"C36A3197FDEE433FB5547EE83DE99E4B",
        "receivedDate":"2026-02-21T06:30:00Z",
        "comment":"Reconciled at site",
        "subjectId":"D313327EF13845169A8ADADDA435431E",
        "packageTypeId":1,
        "unitsPerKit":10,
        "returnedUnits":2,
        "missingUnits":0,
        "balanceUnits":8,
        "verified":1,
        "lastModifiedDate":"2026-02-21T06:45:00Z",
        "kitDescription":"Kit A",
        "distributionSetting":"BLINDED"
    }
]
Nested Schema : SiteUserKitReconciliationTO v6.0
Type: object
Title: SiteUserKitReconciliationTO v6.0
Contains site user kit reconciliation details.
Show Source
Example:
{
    "id":"B1B8327AFAA6412287106192AB5984EF",
    "kitNumber":10001,
    "inventoryStatusId":10,
    "inventoryStatus":"Dispensed",
    "comment":"Received at site"
}
Examples

400 Response

For invalid study and invalid site
Body ()
Root Schema : ORSResponse
Type: object
Common response object.
Show Source
Nested Schema : ErrorResponseData
Type: object
Show Source
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 AND for invalid site and kit number combination.
Body ()
Root Schema : ORSResponse
Type: object
Common response object.
Show Source
Nested Schema : ErrorResponseData
Type: object
Show Source
Nested Schema : result
Type: object
Result Object
Nested Schema : details
Type: object
Examples

500 Response

Internal server error
Body ()
Root Schema : ORSResponse
Type: object
Common response object.
Show Source
Nested Schema : ErrorResponseData
Type: object
Show Source
Nested Schema : result
Type: object
Result Object
Nested Schema : details
Type: object
Examples

Back to Top