REST API for Clinical One Platform

v1.0 REST Endpoints

Randomization and Supplies/Shipment APIs/v1.0

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

~~[Deprecated]: Add additional kits to a received shipment~~: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received/kits
~~[Deprecated]: Mark kits as received for a given site~~: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received
~~[Deprecated]: Update status of a received kit~~: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received/kits
Add kits to an order shipment: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits
Assign Pooling Shipment kits: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders/{shipmentNumber}/assignkits
Cancel recon shipment: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/cancel
Cancel shipments: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/cancel
Confim order shipment: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders/{shipmentId}/confirmed
Create a manual depot shipment in resupply strategy: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/resupply/depotmanual
Create shipment for kits marked for destruction from a given site to depot: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/recon/shipments
Create shipment for kits marked for destruction in a study: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments
Get kit details by order: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits
Get kits eligible to be received against a shipment: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received/eligible-kits
Get kits or a specific kit for a shipment: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/kits
Get list of lost shipments: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/mark-lost
Get order details by a shipment ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders/{shipmentId}
Get order items: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders-inventory/audit
Invalidate order shipment: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders/{shipmentId}/invalid
Mark kits as received: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/received
Mark shipments as lost: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/mark-lost
Received shipment for destruction: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/{shipmentId}/destroyed
Regenerate order form: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/regenerate-order-form
Remove kits from an order shipment: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/removeKits
Search kits by kit type or shipment details: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/eligible-kits
Search orders in the given date range matching the status: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders
Update a Qurantine shipment and its kits: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/receive-quarantined
Update a shipment's ship date: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/{shipmentId}/ship-date
Update a shipment's tracking details: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/{shipmentId}/tracking
Update shipment and its kits as quarantined: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/quarantined
Update shipment as received for destruction: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/{shipmentId}/received
Update shipment details for an order: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders/{shipmentId}
Update shipping date: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/ship-date
Update tracking details for an order shipment: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/tracking