Jump to

• Request
• Response

[Deprecated]: V4.0

get

/ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/kits/{kitId}

Deprecated: Use latest version instead. Retrieves one kit definition from the specified study version. The kitId path parameter identifies the kit, and the response includes kit settings, unit settings, dosing details, titration settings, advanced dosing groups, and validation details when present.

Request

Path Parameters

• kitId(required): string
  Kit ID (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  7A4D3C2B1E8F4D56A23C9F3A0C7D4E22

• studyId(required): string(uuid)
  Study ID (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  F054C951EB74443C93716CA714AB686E

• version(required): string
  Study version path segment. Required. Example: "1.0.0.1".

  Example:

  1.0.0.1

Query Parameters

• kitType: string
  Kit type filter. Optional. Accepted values include STANDARD, TITRATION, ALL, and DEVICE.

  Example:

  STANDARD

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : KitDto v4.0

Type: object

Title: KitDto v4.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 v4.0
  Title: KitSettingsDto v4.0

  Contains settings information on the kit.
• kitTitrations: array kitTitrations
• kitUnitSettings: object KitUnitSettingsDto v4.0
  Title: KitUnitSettingsDto v4.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 date

  Example: 2018-11-23T08:43:01.7Z

{
    "title":"KitDto v4.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "kitid":{
            "type":"string",
            "description":"Kit GUID",
            "format":"uuid"
        },
        "kitSettings":{
            "$ref":"#/components/schemas/KitSettingsDtoV4"
        },
        "kitUnitSettings":{
            "$ref":"#/components/schemas/KitUnitSettingsDtoV4"
        },
        "kitTitrations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KitTitrationsDtoV4"
            }
        },
        "dosings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KitDosingDtoV4"
            }
        },
        "dosage":{
            "type":"number",
            "description":"Dosage.",
            "format":"double",
            "example":50
        },
        "isDefault":{
            "type":"boolean",
            "description":"Is kit default.",
            "example":true
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start date",
            "format":"date-time",
            "example":"2018-11-23T08:43:01.7Z"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "format":"date-time"
        },
        "studyId":{
            "type":"string",
            "description":"Study GUID",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"Study version start",
            "format":"date-time"
        },
        "studyVersionEnd":{
            "type":"string",
            "description":"Study version end",
            "format":"date-time"
        }
    },
    "description":"Kit details."
}

Nested Schema : dosings

Type: array

Show Source

• Array of: object KitDosingDto v4.0
  Title: KitDosingDto v4.0

  Information on a calculated dose.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/KitDosingDtoV4"
    }
}

Nested Schema : KitSettingsDto v4.0

Type: object

Title: KitSettingsDto v4.0

Contains settings information on the kit.

Show Source

• bufferdays: integer (int64)
  The number of buffer days

  Example: 5
• calculatingDoses: boolean
  Indicates if the kit has calculating doses

  Example: true
• deviceConn: string
  Indicates device connection in case of device kit

  Example: Cloud to Cloud
• deviceType: string
  Indicates type of device in case of device kit

  Example: Blood pressure monitor
• dispenseOnHighestDose: boolean
  Indicates if dispensation should happen on up titrate when already on highest dose

  Example: true
• dispenseOnHighestDoseMsg: string
  Message to user on up titrate when subject is on highest dose

  Example: Message when subject is on highest dose
• dispenseOnLowestDose: boolean
  Indicates if dispensation should happen on down titrate when already on lowest dose

  Example: true
• dispenseOnLowestDoseMsg: string
  Message to user on down titrate when subject is on lowest dose

  Example: Message when subject is on lowest dose
• dispenseOutsideWindow: boolean
  Indicates if the kit may be dispensed outside the window

  Example: false
• distributionSetting: string
  Indicates if the kit blinded or unblinded

  Example: BLINDED
• doseChangeUnschVisit: boolean
  Indicates if dosage change is allowed in an unscheduled visit for the titration kit

  Example: false
• dosingFrequency: boolean
  Indicates if the titration kit has dosing frequencies defined

  Example: true
• downTitrateDose: integer (int64)
  The maximum number of down titrate dosage change allowed for the titration kit

  Example: 2
• downTitrateDoseUnscheduled: integer (int64)
  The maximum number of down titrate dosage change allowed for the titration kit for unscheduled visits

  Example: 2
• kitDescription: string
  The kit description

  Example: ORS-123(IP 0.01%)
• kitTypeId: string
  The kit type id

  Example: Type
• maxDoseChanges: integer (int64)
  The maximum number of dosage changes allowed for the titration kit

  Example: 3
• minShipUnits: integer (int64)
  The minimum kit to ship

  Example: 10
• storageSetting: string
  The storage temperature

  Example: AMBIENT
• timeBetweenDownDoseChanges: integer (int64)
  Time between down dosage changes

  Example: 20
• timeBetweenDownDoseChangesUnit: string
  Unit for time between down dosage changes

  Example: DAYS
• timeBetweenUpDoseChanges: integer (int64)
  Time between up dosage changes

  Example: 20
• timeBetweenUpDoseChangesUnit: string
  Unit for time between up dosage changes

  Example: DAYS
• titratingDoses: boolean
  Indicates if the kit has titrating doses

  Example: true
• titrationKit: boolean
  Indicates if the kit is a titration kit

  Example: true
• totalDoseUnscheduled: integer (int64)
  The maximum number of dosage changes allowed for the titration kit for unscheduled visits

  Example: 3
• trialSupplyType: string
  The kit type

  Example: BOTTLE
• upTitrateDose: integer (int64)
  The maximum number of up titrate dosage change allowed for the titration kit

  Example: 1
• upTitrateDoseUnscheduled: integer (int64)
  The maximum number of up titrate dosage change allowed for the titration kit for unscheduled visits

  Example: 1

{
    "title":"KitSettingsDto v4.0",
    "type":"object",
    "properties":{
        "deviceType":{
            "type":"string",
            "description":"Indicates type of device in case of device kit",
            "example":"Blood pressure monitor"
        },
        "deviceConn":{
            "type":"string",
            "description":"Indicates device connection in case of device kit",
            "example":"Cloud to Cloud"
        },
        "calculatingDoses":{
            "type":"boolean",
            "description":"Indicates if the kit has calculating doses",
            "example":true
        },
        "titratingDoses":{
            "type":"boolean",
            "description":"Indicates if the kit has titrating doses",
            "example":true
        },
        "titrationKit":{
            "type":"boolean",
            "description":"Indicates if the kit is a titration kit",
            "example":true
        },
        "distributionSetting":{
            "type":"string",
            "description":"Indicates if the kit blinded or unblinded",
            "example":"BLINDED"
        },
        "kitTypeId":{
            "type":"string",
            "description":"The kit type id",
            "example":"Type"
        },
        "kitDescription":{
            "type":"string",
            "description":"The kit description",
            "example":"ORS-123(IP 0.01%)"
        },
        "storageSetting":{
            "type":"string",
            "description":"The storage temperature",
            "example":"AMBIENT"
        },
        "trialSupplyType":{
            "type":"string",
            "description":"The kit type",
            "example":"BOTTLE"
        },
        "minShipUnits":{
            "type":"integer",
            "description":"The minimum kit to ship",
            "format":"int64",
            "example":10
        },
        "bufferdays":{
            "type":"integer",
            "description":"The number of buffer days",
            "format":"int64",
            "example":5
        },
        "dispenseOutsideWindow":{
            "type":"boolean",
            "description":"Indicates if the kit may be dispensed outside the window",
            "example":false
        },
        "dosingFrequency":{
            "type":"boolean",
            "description":"Indicates if the titration kit has dosing frequencies defined",
            "example":true
        },
        "doseChangeUnschVisit":{
            "type":"boolean",
            "description":"Indicates if dosage change is allowed in an unscheduled visit for the titration kit",
            "example":false
        },
        "maxDoseChanges":{
            "type":"integer",
            "description":"The maximum number of dosage changes allowed for the titration kit",
            "format":"int64",
            "example":3
        },
        "upTitrateDose":{
            "type":"integer",
            "description":"The maximum number of up titrate dosage change allowed for the titration kit",
            "format":"int64",
            "example":1
        },
        "downTitrateDose":{
            "type":"integer",
            "description":"The maximum number of down titrate dosage change allowed for the titration kit",
            "format":"int64",
            "example":2
        },
        "totalDoseUnscheduled":{
            "type":"integer",
            "description":"The maximum number of dosage changes allowed for the titration kit for unscheduled visits",
            "format":"int64",
            "example":3
        },
        "upTitrateDoseUnscheduled":{
            "type":"integer",
            "description":"The maximum number of up titrate dosage change allowed for the titration kit for unscheduled visits",
            "format":"int64",
            "example":1
        },
        "downTitrateDoseUnscheduled":{
            "type":"integer",
            "description":"The maximum number of down titrate dosage change allowed for the titration kit for unscheduled visits",
            "format":"int64",
            "example":2
        },
        "timeBetweenUpDoseChangesUnit":{
            "type":"string",
            "description":"Unit for time between up dosage changes",
            "example":"DAYS"
        },
        "timeBetweenUpDoseChanges":{
            "type":"integer",
            "description":"Time between up dosage changes",
            "format":"int64",
            "example":20
        },
        "timeBetweenDownDoseChangesUnit":{
            "type":"string",
            "description":"Unit for time between down dosage changes",
            "example":"DAYS"
        },
        "timeBetweenDownDoseChanges":{
            "type":"integer",
            "description":"Time between down dosage changes",
            "format":"int64",
            "example":20
        },
        "dispenseOnHighestDose":{
            "type":"boolean",
            "description":"Indicates if dispensation should happen on up titrate when already on highest dose",
            "example":true
        },
        "dispenseOnLowestDose":{
            "type":"boolean",
            "description":"Indicates if dispensation should happen on down titrate when already on lowest dose",
            "example":true
        },
        "dispenseOnHighestDoseMsg":{
            "type":"string",
            "description":"Message to user on up titrate when subject is on highest dose",
            "example":"Message when subject is on highest dose"
        },
        "dispenseOnLowestDoseMsg":{
            "type":"string",
            "description":"Message to user on down titrate when subject is on lowest dose",
            "example":"Message when subject is on lowest dose"
        }
    },
    "description":"Contains settings information on the kit."
}

Nested Schema : kitTitrations

Type: array

Show Source

• Array of: object KitTitrationsDto v4.0
  Title: KitTitrationsDto v4.0

  Contains titrations information on the titration kit.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/KitTitrationsDtoV4"
    }
}

Nested Schema : KitUnitSettingsDto v4.0

Type: object

Title: KitUnitSettingsDto v4.0

Contains unit settings information on the kit.

Show Source

• singleUnitDose: object KitDosingValueUnitsDto v4.0
  Title: KitDosingValueUnitsDto v4.0

  Describes the value/unit pair of the measurement on the calculated dose.
• unitsPerKit: number (double)
  The number of units per kit

  Example: 20

{
    "title":"KitUnitSettingsDto v4.0",
    "type":"object",
    "properties":{
        "unitsPerKit":{
            "type":"number",
            "description":"The number of units per kit",
            "format":"double",
            "example":20
        },
        "singleUnitDose":{
            "$ref":"#/components/schemas/KitDosingValueUnitsDtoV4"
        }
    },
    "description":"Contains unit settings information on the kit."
}

Nested Schema : KitDosingDto v4.0

Type: object

Title: KitDosingDto v4.0

Information on a calculated dose.

Show Source

• dose: object KitDosingDoseDto v4.0
  Title: KitDosingDoseDto v4.0

  Dose information on the calculated dose.
• id: string (uuid)
  Dosing GUID
• measurement: object KitDosingMeasurementDto v4.0
  Title: KitDosingMeasurementDto v4.0

  Kit and subject measurement information on a calculated dose.
• name: string
  Dosing display name

  Example: Name
• question: object KitDosingQuestionDto v4.0
  Title: KitDosingQuestionDto v4.0

  Form and question information on the calculated dose.
• visit: object KitDosingVisitDto v4.0
  Title: KitDosingVisitDto v4.0

  Visit information on the calculated dose.

{
    "title":"KitDosingDto v4.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Dosing GUID",
            "format":"uuid"
        },
        "name":{
            "type":"string",
            "description":"Dosing display name",
            "example":"Name"
        },
        "question":{
            "$ref":"#/components/schemas/KitDosingQuestionDtoV4"
        },
        "visit":{
            "$ref":"#/components/schemas/KitDosingVisitDtoV4"
        },
        "dose":{
            "$ref":"#/components/schemas/KitDosingDoseDtoV4"
        },
        "measurement":{
            "$ref":"#/components/schemas/KitDosingMeasurementDtoV4"
        }
    },
    "description":"Information on a calculated dose."
}

Nested Schema : KitDosingDoseDto v4.0

Type: object

Title: KitDosingDoseDto v4.0

Dose information on the calculated dose.

Show Source

• frequency: string
  Dosing frequency

  Example: Before bedtime
• leftOverUnits: boolean
  Use leftover units in next dose

  Example: true
• precision: integer (int32)
  Precision for each dose

  Example: 1
• roundUp: integer (int32)
  Rounded up for dosing calculation

  Example: 1

{
    "title":"KitDosingDoseDto v4.0",
    "type":"object",
    "properties":{
        "precision":{
            "type":"integer",
            "description":"Precision for each dose",
            "format":"int32",
            "example":1
        },
        "roundUp":{
            "type":"integer",
            "description":"Rounded up for dosing calculation",
            "format":"int32",
            "example":1
        },
        "frequency":{
            "type":"string",
            "description":"Dosing frequency",
            "example":"Before bedtime"
        },
        "leftOverUnits":{
            "type":"boolean",
            "description":"Use leftover units in next dose",
            "example":true
        }
    },
    "description":"Dose information on the calculated dose."
}

Nested Schema : KitDosingMeasurementDto v4.0

Type: object

Title: KitDosingMeasurementDto v4.0

Kit and subject measurement information on a calculated dose.

Show Source

• kit: object KitDosingValueUnitsDto v4.0
  Title: KitDosingValueUnitsDto v4.0

  Describes the value/unit pair of the measurement on the calculated dose.
• subject: object KitDosingValueUnitsDto v4.0
  Title: KitDosingValueUnitsDto v4.0

  Describes the value/unit pair of the measurement on the calculated dose.

{
    "title":"KitDosingMeasurementDto v4.0",
    "type":"object",
    "properties":{
        "kit":{
            "$ref":"#/components/schemas/KitDosingValueUnitsDtoV4"
        },
        "subject":{
            "$ref":"#/components/schemas/KitDosingValueUnitsDtoV4"
        }
    },
    "description":"Kit and subject measurement information on a calculated dose."
}

Nested Schema : KitDosingQuestionDto v4.0

Type: object

Title: KitDosingQuestionDto v4.0

Form and question information on the calculated dose.

Show Source

• formId: string (uuid)
  The form Id
• itemId: string (uuid)
  The question Id

{
    "title":"KitDosingQuestionDto v4.0",
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"The form Id",
            "format":"uuid"
        },
        "itemId":{
            "type":"string",
            "description":"The question Id",
            "format":"uuid"
        }
    },
    "description":"Form and question information on the calculated dose."
}

Nested Schema : KitDosingVisitDto v4.0

Type: object

Title: KitDosingVisitDto v4.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 current

  Example: screening

{
    "title":"KitDosingVisitDto v4.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The visit Id",
            "format":"uuid"
        },
        "type":{
            "type":"string",
            "description":"The type of visit, eg. screening, scheduled, or current",
            "example":"screening"
        }
    },
    "description":"Visit information on the calculated dose."
}

Nested Schema : KitDosingValueUnitsDto v4.0

Type: object

Title: KitDosingValueUnitsDto v4.0

Describes the value/unit pair of the measurement on the calculated dose.

Show Source

• units: string
  The unit of a measurement

  Example: mg
• value: number (double)
  The value of a measurement

  Example: 50

{
    "title":"KitDosingValueUnitsDto v4.0",
    "type":"object",
    "properties":{
        "value":{
            "type":"number",
            "description":"The value of a measurement",
            "format":"double",
            "example":50
        },
        "units":{
            "type":"string",
            "description":"The unit of a measurement",
            "example":"mg"
        }
    },
    "description":"Describes the value/unit pair of the measurement on the calculated dose."
}

Nested Schema : KitTitrationsDto v4.0

Type: object

Title: KitTitrationsDto v4.0

Contains titrations information on the titration kit.

Show Source

• downTitrationKitJson: object TitrationKitItemsDto v4.0
  Title: TitrationKitItemsDto v4.0

  Titration Kit Items
• rowId: string (uuid)
  Id of the titration row
• titrationKitId: string (uuid)
  Id of the current titration kit
• titrationKitJson: object TitrationKitItemsDto v4.0
  Title: TitrationKitItemsDto v4.0

  Titration Kit Items
• titrationKitSeq: integer (int64)
  Sequence number of the current titration row within the kit

  Example: 5
• upTitrationKitJson: object TitrationKitItemsDto v4.0
  Title: TitrationKitItemsDto v4.0

  Titration Kit Items

{
    "title":"KitTitrationsDto v4.0",
    "type":"object",
    "properties":{
        "rowId":{
            "type":"string",
            "description":"Id of the titration row",
            "format":"uuid"
        },
        "titrationKitId":{
            "type":"string",
            "description":"Id of the current titration kit",
            "format":"uuid"
        },
        "titrationKitSeq":{
            "type":"integer",
            "description":"Sequence number of the current titration row within the kit",
            "format":"int64",
            "example":5
        },
        "titrationKitJson":{
            "$ref":"#/components/schemas/TitrationKitItemsDtoV4"
        },
        "upTitrationKitJson":{
            "$ref":"#/components/schemas/TitrationKitItemsDtoV4"
        },
        "downTitrationKitJson":{
            "$ref":"#/components/schemas/TitrationKitItemsDtoV4"
        }
    },
    "description":"Contains titrations information on the titration kit."
}

Nested Schema : TitrationKitItemsDto v4.0

Type: object

Title: TitrationKitItemsDto v4.0

Titration Kit Items

Show Source

• titrationKitItems: array titrationKitItems

{
    "title":"TitrationKitItemsDto v4.0",
    "type":"object",
    "properties":{
        "titrationKitItems":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TitrationKitItemDtoV4"
            }
        }
    },
    "description":"Titration Kit Items"
}

Nested Schema : titrationKitItems

Type: array

Show Source

• Array of: object TitrationKitItemDto v4.0
  Title: TitrationKitItemDto v4.0

  Titration Kit Item

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TitrationKitItemDtoV4"
    }
}

Nested Schema : TitrationKitItemDto v4.0

Type: object

Title: TitrationKitItemDto v4.0

Titration Kit Item

Show Source

• kitDosage: string
  Kit Dosage

  Example: QD
• kitid: string (uuid)
  Kit GUID
• kitSeq: integer (int64)
  Kit Sequence

  Example: 1

{
    "title":"TitrationKitItemDto v4.0",
    "type":"object",
    "properties":{
        "kitid":{
            "type":"string",
            "description":"Kit GUID",
            "format":"uuid"
        },
        "kitSeq":{
            "type":"integer",
            "description":"Kit Sequence",
            "format":"int64",
            "example":1
        },
        "kitDosage":{
            "type":"string",
            "description":"Kit Dosage",
            "example":"QD"
        }
    },
    "description":"Titration Kit Item"
}

Examples

Select an example successResponse

500 Response

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.

Body ()

Root Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Back to Top