Get dispensation details by inventory ID
get
/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/{inventoryId}/dispensation
Retrieves dispensation details like subject source ID, visit source ID and instance number for a given inventory ID. Rights: OrsInventoryGet.
Request
Path Parameters
-
inventoryId(required): string(uuid)
ID of the inventory
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
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 : KitStatusHistoryResponse
Type:
object
Response object of kit status history
Show Source
-
inventoryStatus: string
Allowed Values:
[ "Available", " Damaged", " Destroyed", " Dispensed", " Expired", " Not in Use", " Misallocated", " Missing", " In Transit", " Quarantined", " Pre-quarantined", " Pending Destruction", " Lost by Subject", " Temporarily Unavailable", " Damaged by Subject", " New", " Not Dispensed to Subject", " Returned to Site" ]
Inventory statusExample:New, Damaged
-
inventoryStatusId: number
(BigDecimal)
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
-
missingUnits: number
(BigDecimal)
Missing Units of KitExample:
5
-
modifiedDate: string
(date-time)
Date modified
-
reason: string
Reason descriptionExample:
Some description
-
returnedUnits: number
(BigDecimal)
Returned Units of KitExample:
10
-
userName: string
User name
404 Response
Invalid study ID or version
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