Mark kits as received
post
/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/received
Marks kits as received in a study's inventory. Rights: OrsInventoryPost and DepotShipmentReceiptPost/OrsBlinded.
Request
Path Parameters
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
shipmentId(required): string(uuid)
ID of the shipment.
-
studyId(required): string(uuid)
ID of the study
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
tempMonitorStatus: string
Allowed Values:
[ "yes", "no", "missing" ]
Pattern:yes|no|missing
Temprature Montior StatusExample:yes
-
updateKits: object
updateKits
Additional Properties Allowed: additionalProperties
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ShipmentReceivedResponse
Type:
object
Received shipment details response object.
Show Source
-
availableCount: integer
(int64)
Available kits count.Example:
5
-
damagedCount: integer
(int64)
Damaged kits count.Example:
5
-
missingCount: integer
(int64)
Missing kits count.Example:
5
-
preQuarantinedCount: integer
(int64)
Pre quarantined kits count.Example:
5
-
receivedDate: string
(date-time)
Shipment received date.
-
shipmentId: string
(uuid)
ID of the shipment.
400 Response
'Invalid order status', 'Invalid kit'
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object
404 Response
'Invalid study ID', 'Study still in Draft (design phase)', 'Invalid shipment ID', 'Invalid site ID'
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object
500 Response
Internal server error
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object