v2.0 REST Endpoints

Sort by

Task Path Method

Randomization and Supplies/Shipment APIs/v2.0

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

[Deprecated]: Mark kits as received for a given site

Method: post

Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received

Create a resupply strategy

Method: post

Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupply/resupply

Create first shipment in resupply strategy

Method: post

Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupply/initial

Create manual shipment in resupply strategy

Method: post

Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupply/manual

Create shipment for kits marked for destruction from a given site to depot

Method: post

Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/recon/shipments

Get a shipment's details by ID for a site

Method: get

Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}

Get kit details by order

Method: get

Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits

Get kits or a specific kit for a shipment

Method: get

Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/kits

Get order details by a shipment ID

Method: get

Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/orders/{shipmentId}

Get shipment by shipment ID

Method: get

Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}

Initiate manual resupply to a site

Method: post

Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/resupply/manual

List available order status values

Method: get

Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipment-statuses

Mark kits as received

Method: post

Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/received

Search kits by kit type or shipment details

Method: get

Path: /ec-ors-svc/rest/v2.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/v2.0/studies/{studyId}/{mode}/orders

Search shipments for a site

Method: get

Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/shipments

Search shipments for a study

Method: get

Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments

Update shipment and its kits as quarantined

Method: post

Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/quarantined

Update shipment details for an order with deliveryNumber

Method: put

Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/orders/{shipmentId}