Get unblinded dispensation history
get
/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/unblinded-disp-history
Retrieves history of unblinded dispensation for a subject within the study. Rights: OrsSubjectVisitGet.
Request
Path Parameters
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
srcSubjectId(required): string(uuid)
ID of the subject
-
studyId(required): string(uuid)
ID of the study
Query Parameters
-
visitId(required): string
ID of the visit
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : UnblindedDispensationHistoryDTO
Type:
object
Title:
UnblindedDispensationHistoryDTO
Contains unblinded dispensation history.
Show Source
Nested Schema : kitTypes
Type:
Show Source
array
-
Array of:
object KitTypeDetailsDTO
Title:
KitTypeDetailsDTO
Contains kit type details.
Nested Schema : KitTypeDetailsDTO
Type:
object
Title:
KitTypeDetailsDTO
Contains kit type details.
Show Source
-
description: string
Kit Type descriptionExample:
Kit A
-
dispensationDetails: array
dispensationDetails
-
id: string
(uuid)
ID of the kit type.
-
kitTypeName: string
Kit Type nameExample:
Kit A
-
packageType: string
Allowed Values:
[ "BLISTERPACK", "BOTTLE", "DEVICE", "SYRINGE", "OINTMENT", "VIAL", "INHALER", "INFUSION", "BOX", "OTHER" ]
Package TypeExample:INHALER
-
packageTypeId: number
(double)
Allowed Values:
[ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10" ]
Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).Example:2
Nested Schema : dispensationDetails
Type:
Show Source
array
-
Array of:
object KitDispensationDTO
Title:
KitDispensationDTO
Contains kit dispensation details.
Nested Schema : KitDispensationDTO
Type:
object
Title:
KitDispensationDTO
Contains kit dispensation details.
Show Source
-
dispensationDate: string
(date-time)
Dispensation date
-
inventoryStatus: number
(double)
Inventory status Id.Example:
5
-
kitNumber: number
(double)
Kit nuumber.Example:
5
400 Response
Invalid parameters
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 or version. Or subject not found
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