Get a shipment's details by ID for a site
get
/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}
Retrieves a shipments' details by ID for a site. Rights: OrsSupplyManagerGet and OrsBlinded.
Request
Path Parameters
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
shipmentId(required): string(uuid)
ID of the shipment.
-
siteId(required): string(uuid)
ID of the site
-
studyId(required): string(uuid)
ID of the study
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : SiteUserShipmentTOV2
Type:
object
Response object containing details about shipment at a site.
Show Source
-
availableCount: integer
(int64)
Available kits count.Example:
5
-
createdDate: string
(date-time)
Shipment creation date
-
damagedCount: integer
(int64)
Damaged kits count.Example:
5
-
depotId: string
(uuid)
Depot Id
-
depotName: string
Name of the depot.Example:
Depot Houston
-
depotShortName: string
Short identifier for the depot, such as a number.Example:
123
-
inTransitCount: integer
(int64)
In transit kits count.Example:
5
-
missingCount: integer
(int64)
Missing kits count.Example:
5
-
preQuarantinedCount: integer
(int64)
Pre quarantined kits count.Example:
5
-
reconciliation: boolean
Indicate if kit reconciliation is there.Example:
true
-
reportId: string
Report Id.Example:
B1B8327AFAA6412287106192AB5984EF
-
shipDate: string
(date-time)
Ship date.
-
shipmentId: string
ID of the shipment.Example:
123
-
shipmentNumber: string
Shipment number.Example:
123
-
siteId: string
(uuid)
ID of the site
-
siteName: string
Name of the site.Example:
Site Houston
-
siteShortName: string
Short identifier for the site, such as a number.Example:
12
-
statusDate: string
(date-time)
Status date.
-
statusId: number
(Integer)
Shipment status Id.Example:
5
-
trackingNumber: string
Shipment tracking number.Example:
12345
-
trackingNumberURL: string
Shipment tracking url.Example:
http://www.site.com
404 Response
'Invalid study ID', 'Study still in Draft (design phase)', 'Invalid site ID', 'Invalid shipment ID'
Nested Schema : result
Type:
object
Nested Schema : details
Type:
object
500 Response
Internal server error
Nested Schema : result
Type:
object
Nested Schema : details
Type:
object