REST API for Clinical One Platform

v1.0 REST Endpoints

Randomization and Supplies/Inventory APIs/v1.0

The operations from the Randomization and Supplies/Inventory APIs/v1.0 category.

~~[Deprecated]: Create randomization list from uploaded file~~: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/fileupload/rndlists/{rndListId}
~~[Deprecated]: Get a kit's last status by kit number~~: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{kitNumber}/lastStatus
~~[Deprecated]: Get kit history~~: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{kitNumber}/history
~~[Deprecated]: Get kit history by ID for a site~~: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{inventoryId}/historyById
~~[Deprecated]: Get kit history by kit number for a site~~: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitNumber}/history
~~[Deprecated]: Get latest status of kit in site inventory~~: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitNumber}/lastStatus
Create blinded lot: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/blinded-lots
Create label groups: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/label-groups
Create manufacturing lot: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots
Delete blinded lot: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/blinded-lots/{id}
Delete kit list file: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/upload/file/{fileId}
Delete label groups: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/label-groups/{id}
Delete manufacturing lot by ID: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
Disable kitlist with inventories: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kitlists/{listId}/disable
Export kit details for the inventory: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{sourceId}/export
Generate kits: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/generate
Get a kit's barcode by kit ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{kitId}/barcode
Get a kit's last status by inventory ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{inventoryId}/lastStatusById
Get a site inventory's status: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventorystatuses/site
Get all manufacturing lots: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots
Get allowed inventory status: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventorystatuses/allowed/{fromInventoryStatusId}
Get blinded lot by ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/blinded-lots/{id}
Get cancelled inventory status: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventorystatuses/cancelledshipment
Get destruction inventory statuses: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventorystatuses/destruction
Get dispensation details by inventory ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/{inventoryId}/dispensation
Get generated/uploaded kit lists details in a study: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kitlists
Get inventory database headers: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/dbheaders/uploadkits
Get kit details by kit number: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kitDetails
Get Kit History by depotId and kitId: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/depots/{depotId}/inventory/kits/{inventoryId}/historyById
Get kit history by ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{inventoryId}/historyById
Get kit summary by kit type ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kit-types/{kitTypeId}/kits
Get kit types: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kit-types
Get kits from depot inventory by depot ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/depots/{depotId}/inventory/kits
Get label groups: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/label-groups
Get label groups by ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/label-groups/{id}
Get latest status of kit in site inventory: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{inventoryId}/lastStatusById
Get list of blinded lots: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/blinded-lots
Get list of filtered kits: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/qualified-kits
Get lots with kits: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lotsWithKits
Get manufacturing lot by ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
Get max kit number: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/suggested-max-numbers
Get pending Destruction count by location ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kit-types/location/{locationId}/pendingdestructioncount
Get randomization list database headers: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/dbheaders/uploadrndlist
Get single kit settings: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/singlekitsettings
Get sites: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites
Get study settings: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/settings
Get types of packages: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/packagetypes
Kitlist details of each kit: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/audit
Parse file headers: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/upload/{fileId}/fileheaders
Set kit verification status: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitId}/verify
Update a kit's barcode: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/barcode
Update a kit's barcode by kit ID: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{kitId}/barcode
Update a kit's dispensation confirmation: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{kitId}/confirmDispensation
Update blinded lot: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/blinded-lots/{id}
Update kit attributes: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits
Update kit attributes from depot inventory by depot ID: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/depots/{depotId}/inventory/kits
Update kit label group: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/label-group
Update kit location: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/location
Update kit manufactoring lot: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/manufacturing-lot
Update kit status: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/status
Update label groups: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/label-groups/{id}
Update manufacturing lot by ID: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
Upload inventory data as CSV file: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/upload/uploadinventory
Upload kit list file: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/upload/uploadfile
Upload kit types data: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/upload/kittypesfromfile