Get reusable kits
get
/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/reuse-kits
Get previously dispensed kits that can be reused in the current visit for a give 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
Query Parameters
-
instanceNumber: number
Instance number for unscheduled visit.
-
studyVersion(required): string
Version of the study
-
titrationOption: string
Titration options to dispense kits. For example: up/down/maintain.
-
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 : ReusableKitsResponse v1.0
Type:
object
Title:
ReusableKitsResponse v1.0
Contains details of reusable kits.
Show Source
-
kits: array
kits
-
status(required): string
Allowed Values:
[ "ALLOW, REUSE_NOT_ALLOWED" ]
reuse allowed or notExample:ALLOW
Nested Schema : kits
Type:
Show Source
array
-
Array of:
object ReusableKit
Title:
ReusableKit
Response containing reusable kit details
Nested Schema : ReusableKit
Type:
object
Title:
ReusableKit
Response containing reusable kit details
Show Source
-
consumeAcrossDoses: boolean
Indicate if consume across dosed allowed.Example:
true
-
dose: number
(double)
Dose.Example:
5
-
frequency: string
Allowed Values:
[ "Once", "QD", "BID", "TID", "QID", "Q3", "Q4", "Q8", "Q12", "Q24", "Bedtime", "With meals", "With meals and at bedtime" ]
Dosing frequency.Example:BID
-
id: number
(Integer)
Id of the reusable kit.Example:
2
-
inventoryId: string
Inventory IdExample:
D313327EF13845169A8ADADDA435431E
-
kitDescription: string
Kit descriptionExample:
Kit A
-
measurement: string
Dose Measurement.Example:
ml
-
trialSupplyType: string
Trial Supply TypeExample:
BOTTLE
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