Get list of all kits
get
/ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/kits
Retrieves list of kits in a study.
Request
Path Parameters
-
studyId(required): string(uuid)
Study ID. Example: F054C951EB74443C93716CA714AB686E
-
version(required): string
Study version. Example: "1.0.0.1"
Query Parameters
-
kitType(required): string
Visit GUID.Example:
STANDARD
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object KitDto v6.0
Title:
KitDto v6.0
Kit details.
Nested Schema : KitDto v6.0
Type:
object
Title:
KitDto v6.0
Kit details.
Show Source
-
dosage: number
(double)
Dosage.Example:
50
-
dosings: array
dosings
-
id: string
(uuid)
-
isDefault: boolean
Is kit default.Example:
true
-
kitid: string
(uuid)
Kit GUID
-
kitSettings: object
KitSettingsDto v5.0
Title:
KitSettingsDto v5.0
Contains settings information on the kit. -
kitTitrations: array
kitTitrations
-
kitUnitSettings: object
KitUnitSettingsDto v5.0
Title:
KitUnitSettingsDto v5.0
Contains unit settings information on the kit. -
studyId: string
(uuid)
Study GUID
-
studyVersionEnd: string
(date-time)
Study version end
-
studyVersionStart: string
(date-time)
Study version start
-
versionEnd: string
(date-time)
Version End
-
versionStart: string
(date-time)
Version Start
Nested Schema : dosings
Type:
Show Source
array
-
Array of:
object KitDosingDto v5.0
Title:
KitDosingDto v5.0
Information on a calculated dose.
Nested Schema : KitSettingsDto v5.0
Type:
object
Title:
KitSettingsDto v5.0
Contains settings information on the kit.
Show Source
-
bufferdays: integer
(int64)
The number of buffer daysExample:
5
-
calculatingDoses: boolean
Indicates if the kit has calculating dosesExample:
true
-
deviceConn: string
Indicates device connection in case of device kitExample:
Cloud to Cloud
-
deviceType: string
Indicates type of device in case of device kitExample:
Blood pressure monitor
-
dispenseOnHighestDose: boolean
Indicates if dispensation should happen on up titrate when already on highest doseExample:
true
-
dispenseOnHighestDoseMsg: string
Message to user on up titrate when subject is on highest doseExample:
Message when subject is on highest dose
-
dispenseOnLowestDose: boolean
Indicates if dispensation should happen on down titrate when already on lowest doseExample:
true
-
dispenseOnLowestDoseMsg: string
Message to user on down titrate when subject is on lowest doseExample:
Message when subject is on lowest dose
-
dispenseOutsideWindow: boolean
Indicates if the kit may be dispensed outside the windowExample:
false
-
distributionSetting: string
Indicates if the kit blinded or unblindedExample:
BLINDED
-
doseChangeUnschVisit: boolean
Indicates if dosage change is allowed in an unscheduled visit for the titration kitExample:
false
-
dosingFrequency: boolean
Indicates if the titration kit has dosing frequencies definedExample:
true
-
downTitrateDose: integer
(int64)
The maximum number of down titrate dosage change allowed for the titration kitExample:
2
-
downTitrateDoseUnscheduled: integer
(int64)
The maximum number of down titrate dosage change allowed for the titration kit for unscheduled visitsExample:
2
-
kitDescription: string
The kit descriptionExample:
ORS-123(IP 0.01%)
-
kitTypeId: string
The kit type idExample:
Type
-
maxDoseChanges: integer
(int64)
The maximum number of dosage changes allowed for the titration kitExample:
3
-
minShipUnits: integer
(int64)
The minimum kit to shipExample:
10
-
storageSetting: string
The storage temperatureExample:
AMBIENT
-
timeBetweenDownDoseChanges: integer
(int64)
Time between down dosage changesExample:
20
-
timeBetweenDownDoseChangesUnit: string
Unit for time between down dosage changesExample:
DAYS
-
timeBetweenUpDoseChanges: integer
(int64)
Time between up dosage changesExample:
20
-
timeBetweenUpDoseChangesUnit: string
Unit for time between up dosage changesExample:
DAYS
-
titratingDoses: boolean
Indicates if the kit has titrating dosesExample:
true
-
titrationKit: boolean
Indicates if the kit is a titration kitExample:
true
-
totalDoseUnscheduled: integer
(int64)
The maximum number of dosage changes allowed for the titration kit for unscheduled visitsExample:
3
-
trialSupplyType: string
The kit typeExample:
BOTTLE
-
upTitrateDose: integer
(int64)
The maximum number of up titrate dosage change allowed for the titration kitExample:
1
-
upTitrateDoseUnscheduled: integer
(int64)
The maximum number of up titrate dosage change allowed for the titration kit for unscheduled visitsExample:
1
Nested Schema : kitTitrations
Type:
Show Source
array
-
Array of:
object KitTitrationsDto v5.0
Title:
KitTitrationsDto v5.0
Contains titrations information on the titration kit.
Nested Schema : KitUnitSettingsDto v5.0
Type:
object
Title:
KitUnitSettingsDto v5.0
Contains unit settings information on the kit.
Show Source
-
singleUnitDose: object
KitDosingValueUnitsDto v5.0
Title:
KitDosingValueUnitsDto v5.0
Describes the value/unit pair of the measurement on the calculated dose. -
unitsPerKit: number
(double)
The number of units per kitExample:
20
Nested Schema : KitDosingDto v5.0
Type:
object
Title:
KitDosingDto v5.0
Information on a calculated dose.
Show Source
-
dose: object
KitDosingDoseDto v5.0
Title:
KitDosingDoseDto v5.0
Dose information on the calculated dose. -
id: string
(uuid)
Dosing GUID
-
measurement: object
KitDosingMeasurementDto v5.0
Title:
KitDosingMeasurementDto v5.0
Kit and subject measurement information on a calculated dose. -
name: string
Dosing display nameExample:
Name
-
question: object
KitDosingQuestionDto v5.0
Title:
KitDosingQuestionDto v5.0
Form and question information on the calculated dose. -
visit: object
KitDosingVisitDto v5.0
Title:
KitDosingVisitDto v5.0
Visit information on the calculated dose.
Nested Schema : KitDosingDoseDto v5.0
Type:
object
Title:
KitDosingDoseDto v5.0
Dose information on the calculated dose.
Show Source
-
frequency: string
Dosing frequencyExample:
Before bedtime
-
leftOverUnits: boolean
Use leftover units in next doseExample:
true
-
precision: integer
(int32)
Precision for each doseExample:
1
-
roundUp: integer
(int32)
Rounded up for dosing calculationExample:
1
Nested Schema : KitDosingMeasurementDto v5.0
Type:
object
Title:
KitDosingMeasurementDto v5.0
Kit and subject measurement information on a calculated dose.
Show Source
-
kit: object
KitDosingValueUnitsDto v5.0
Title:
KitDosingValueUnitsDto v5.0
Describes the value/unit pair of the measurement on the calculated dose. -
subject: object
KitDosingValueUnitsDto v5.0
Title:
KitDosingValueUnitsDto v5.0
Describes the value/unit pair of the measurement on the calculated dose.
Nested Schema : KitDosingQuestionDto v5.0
Type:
object
Title:
KitDosingQuestionDto v5.0
Form and question information on the calculated dose.
Show Source
-
formId: string
(uuid)
The form Id
-
itemId: string
(uuid)
The question Id
Nested Schema : KitDosingVisitDto v5.0
Type:
object
Title:
KitDosingVisitDto v5.0
Visit information on the calculated dose.
Show Source
-
id: string
(uuid)
The visit Id
-
type: string
The type of visit, eg. screening, scheduled, or currentExample:
screening
Nested Schema : KitDosingValueUnitsDto v5.0
Type:
object
Title:
KitDosingValueUnitsDto v5.0
Describes the value/unit pair of the measurement on the calculated dose.
Show Source
-
units: string
The unit of a measurementExample:
mg
-
value: number
(double)
The value of a measurementExample:
50
Nested Schema : KitTitrationsDto v5.0
Type:
object
Title:
KitTitrationsDto v5.0
Contains titrations information on the titration kit.
Show Source
-
downTitrationKitJson: object
TitrationKitItemsDto v5.0
Title:
TitrationKitItemsDto v5.0
Titration Kit Items -
maintainTitrationKitJson: object
TitrationKitItemsDto v5.0
Title:
TitrationKitItemsDto v5.0
Titration Kit Items -
rowId: string
(uuid)
Id of the titration row
-
titrationKitId: string
(uuid)
Id of the current titration kit
-
titrationKitJson: object
TitrationKitItemsDto v5.0
Title:
TitrationKitItemsDto v5.0
Titration Kit Items -
titrationKitLabel: string
Custom optional Dose Level title to indicate a dose level for a row within a Titration GroupExample:
Low Dose
-
titrationKitSeq: integer
(int64)
Sequence number of the current titration row within the kitExample:
5
-
upTitrationKitJson: object
TitrationKitItemsDto v5.0
Title:
TitrationKitItemsDto v5.0
Titration Kit Items
Nested Schema : TitrationKitItemsDto v5.0
Type:
object
Title:
TitrationKitItemsDto v5.0
Titration Kit Items
Show Source
Nested Schema : titrationKitItems
Type:
Show Source
array
-
Array of:
object TitrationKitItemDto v5.0
Title:
TitrationKitItemDto v5.0
Titration Kit Item
Nested Schema : TitrationKitItemDto v5.0
Type:
object
Title:
TitrationKitItemDto v5.0
Titration Kit Item
Show Source
-
kitDosage: string
Kit DosageExample:
QD
-
kitid: string
(uuid)
Kit GUID
-
kitSeq: integer
(int64)
Kit SequenceExample:
1
500 Response
Error
Nested Schema : details
Type:
object