[Deprecated]: Update status of a received kit
put
/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received/kits
Deprecated: Use latest version instead. Updates status of received kit in the system. Rights: OrsSupplyManagerPost 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
ID of the site
-
studyId(required): string(uuid)
ID of the study
Supported Media Types
- application/json
Root Schema : schema
Type:
object
Request object containing shipment kits to be updated.
Show Source
-
kits(required): array
kits
Minimum Number of Items:
1
Maximum Number of Items:2147483647
Contains kit Ids. -
toInventoryStatus(required): integer
(int32)
Allowed Values:
[ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20" ]
Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).Example:5
Nested Schema : kits
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
2147483647
Contains kit Ids.
Show Source
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', 'Invalid inventory status value'
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'
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