Get unblinded dispensation history for all subjects
get
/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/unblinded-disp-history
Retrieves unblinded dispensation history for all subjects within the study. Rights: OrsSubjectVisitGet.
Request
Path Parameters
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
studyId(required): string(uuid)
ID of the study
Query Parameters
-
audit: boolean
Value of audit parameter
-
instanceNumber: number
Instance number for unscheduled visit.
-
subjectId: string
ID of the subject
-
visitId: 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 : DispensationHistoryResponseForAllSubject v2.0
Type:
object
Title:
DispensationHistoryResponseForAllSubject v2.0
Contains unblinded dispensation history for all subjects.
Show Source
-
conserved: boolean
-
dispensationConfirmed: boolean
-
dispensationDate: string
(date-time)
Dispensation date
-
dose: number
(double)
Dose.
-
frequency: string
Frequency
-
instanceNumber: number
(double)
Instance number.
-
inventoryId: string
(uuid)
Inventory Id.
-
inventoryStatus: string
Inventory Status
-
inventoryStatusId: number
(double)
Inventory Status Id.
-
kitNumberUTF: string
Kit Number in UTF8 format.
-
kitTypeSrcId: string
(uuid)
Kit Type Source Id.
-
measurement: string
Measurement unit
-
mHealthDeviceId: string
mHealthDevice Id
-
missingUnits: number
(double)
Number of Missing Units.
-
objectVersionNumber: number
(double)
Object Version Number.
-
returnedUnits: number
(double)
Number of Return Units.
-
siteId: string
(uuid)
Site Id.
-
subjectId: string
(uuid)
Subject Id.
-
versionEnd: string
(date-time)
Version end date
-
versionStart: string
(date-time)
Version start date
-
visitId: string
(uuid)
Visit Id.
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