Get kits which are marked as dose hold
get
/ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/doseheld
Get kits which are marked as dose hold for given search critera. 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
-
subjectId(required): string(uuid)
ID of the subject
Query Parameters
-
asofdate: string
-
instanceNumber: number
Instance number for unscheduled visit.
-
visitId(required): string(uuid)
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 : DoseHoldKit v3.0
Type:
object
Title:
DoseHoldKit v3.0
Response containing dose hold kit details
Show Source
-
blindedTItrationLabel: string
Blinded TItration LabelExample:
Low dose
-
Date: string
(date-time)
transactionDateExample:
2017-09-26T15:40:14.357Z
-
deviceType: string
mHealth Device TypeExample:
ActivityWatch
-
instanceNumber: number
instanceNumberExample:
1
-
isTitration: boolean
Indicate if titrationExample:
true
-
isUnblindedPharmacist: boolean
Indicate if Unblinded Pharmacist kitExample:
true
-
kitDescription: string
Kit descriptionExample:
Kit A
-
kitTypeSrcId: string
Kit Type IdExample:
D313327EF13845169A8ADADDA435431E
-
reason: string
Reason for kits not allowed for dose holdExample:
DOSE_HOLD_VISIT_NOT_STARTED
-
trialSupplyType: string
Trial Supply TypeExample:
BOTTLE
-
UserId: string
(uuid)
UserId
-
visitId: string
(uuid)
visitId
400 Response
Invalid subject OR Scheduled visit with instance number OR Unscheduled visit with no instance number
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