Get kit types
get
/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/kit-types
Retrieves kit types by study ID. Rights: OrsInventoryGet.
Request
Path Parameters
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
studyId(required): string(uuid)
ID of the study
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- */*
204 Response
Successful operation
Root Schema : schema
Type:
Show Source
array
-
Array of:
object KitTypesTO
Contains details about kit types.
Nested Schema : KitTypesTO
Type:
object
Contains details about kit types.
Show Source
-
bufferdays: number
(double)
Buffer days.Example:
5
-
deviceConnection: string
Allowed Values:
[ "CloudtoCloud", "DevicetoCloud", "NoConnection" ]
Device Connection TypeExample:DevicetoCloud
-
deviceType: string
Allowed Values:
[ "ActivityWatch", "BloodPressureMonitor", "WeightScale", "ECGReader", "Spirometer", "MobileApp", "SmartPillBottle", "PulseOximeter", "WearablePatch", "Other", "GlucoseMonitor" ]
Device TypeExample:WearablePatch
-
dispenseOutsideWindow: string
Allowed Values:
[ "0", "1" ]
Indicate whether to dispense kits outside window.Example:1
-
distributionSetting: string
Allowed Values:
[ "BLINDED", "UNBLINDED" ]
Kit distribution setting.Example:BLINDED
-
dosage: number
(double)
Kit dosage.Example:
5
-
id: string
(uuid)
Unique identifier
-
isDefault: string
Indicate if kit type is default.Example:
1
-
kitDescription: string
Kit descriptionExample:
Some description
-
kitId: string
(uuid)
Kit Id.
-
kitTypeId: string
Kit type ID.Example:
kit_A
-
minShipUnits: number
(double)
Mininum kits to ship.Example:
5
-
srcId: string
(uuid)
Unique identifier
-
storageSetting: string
Allowed Values:
[ "AMBIENT", "REFRIGERATED", "FROZEN" ]
Kit storage setting.Example:REFRIGERATED
-
studyId: string
(uuid)
ID of the study
-
studyVersionEnd: string
(date-time)
Study version end.
-
studyVersionStart: string
(date-time)
Study version start.
-
trialSupplyType: string
Trial supply type for the kit.Example:
BOTTLE
-
unitsPerKit: number
(double)
Units per KitExample:
5
-
versionEnd: string
(date-time)
Version End
-
versionStart: string
(date-time)
Version Start
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