Get dose hold history
get
/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/doseheld-history
Get dose hold history for current subject. 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
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : KitDoseHeldHistoryTO
Type:
Show Source
object
-
canBeDispensed: boolean
Indicate if the dosehold kit can be dispensed.Example:
true
-
instanceNumber: number
(BigDecimal)
Minimum Value:
1
Instance number of the unscheduled visitExample:2
-
objectVersionNumber: number
(double)
Object version numberExample:
5
-
userId: string
(uuid)
User Id
-
versionEnd: string
(date-time)
Version End
-
versionStart: string
(date-time)
Version Start
-
visitId: string
(uuid)
ID of the visit
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