Jump to

• Request
• Response

V9.0

get

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

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:

  ALL

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 v9.0

Type: object

Title: KitDto v9.0

Kit details.

Show Source

• advancedDosing: integer (int32)
• advancedDosingGroups: array advancedDosingGroups
• dosage: number (double)
  Dosage.

  Example: 50
• dosings: array dosings
• exceptions: array exceptions
• id: string (uuid)
• isDefault: boolean
  Is kit default.

  Example: true
• kitid: string (uuid)
  Kit GUID
• kitSettings: object KitSettingsDto v8.0
  Title: KitSettingsDto v8.0

  Contains settings information on the kit.
• kitTitrations: array kitTitrations
• kitUnitSettings: object KitUnitSettingsDto v8.0
  Title: KitUnitSettingsDto v8.0

  Contains unit settings information on the kit.
• libraryKitId: string (uuid)
  Library Kit GUID
• poolingId: string
  Pooling Kit ID

  Example: POL12
• 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 v9.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "kitid":{
            "type":"string",
            "description":"Kit GUID",
            "format":"uuid"
        },
        "kitSettings":{
            "$ref":"#/components/schemas/KitSettingsDtoV8"
        },
        "kitUnitSettings":{
            "$ref":"#/components/schemas/KitUnitSettingsDtoV8"
        },
        "kitTitrations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KitTitrationsDtoV8"
            }
        },
        "dosings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KitDosingDtoV8"
            }
        },
        "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"
        },
        "exceptions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KitTitrationsDtoV8"
            }
        },
        "advancedDosing":{
            "type":"integer",
            "format":"int32"
        },
        "advancedDosingGroups":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AdvancedDosingGroupDtoV1"
            }
        },
        "libraryKitId":{
            "type":"string",
            "description":"Library Kit GUID",
            "format":"uuid"
        },
        "poolingId":{
            "type":"string",
            "description":"Pooling Kit ID",
            "example":"POL12"
        }
    },
    "description":"Kit details."
}

Nested Schema : advancedDosingGroups

Type: array

Show Source

• Array of: object Advanced Dosing Group v1.0
  Title: Advanced Dosing Group v1.0

  Advanced Dosing Group details

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

Nested Schema : dosings

Type: array

Show Source

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

  Information on a calculated dose.

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

Nested Schema : exceptions

Type: array

Show Source

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

  Contains titrations information on the titration kit.

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

Nested Schema : KitSettingsDto v8.0

Type: object

Title: KitSettingsDto v8.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
• timeBetweenDownDoseChangesException: boolean (true)
  Time between down dosage changes exception

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

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

  Example: 20
• timeBetweenUpDoseChangesException: boolean (true)
  Time between up dosage changes exception

  Example: true
• 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 v8.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
        },
        "timeBetweenUpDoseChangesException":{
            "type":"boolean",
            "description":"Time between up dosage changes exception",
            "format":"true",
            "example":true
        },
        "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
        },
        "timeBetweenDownDoseChangesException":{
            "type":"boolean",
            "description":"Time between down dosage changes exception",
            "format":"true",
            "example":true
        },
        "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 v8.0
  Title: KitTitrationsDto v8.0

  Contains titrations information on the titration kit.

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

Nested Schema : KitUnitSettingsDto v8.0

Type: object

Title: KitUnitSettingsDto v8.0

Contains unit settings information on the kit.

Show Source

• singleUnitDose: object KitDosingValueUnitsDto v8.0
  Title: KitDosingValueUnitsDto v8.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 v8.0",
    "type":"object",
    "properties":{
        "unitsPerKit":{
            "type":"number",
            "description":"The number of units per kit",
            "format":"double",
            "example":20
        },
        "singleUnitDose":{
            "$ref":"#/components/schemas/KitDosingValueUnitsDtoV8"
        }
    },
    "description":"Contains unit settings information on the kit."
}

Nested Schema : Advanced Dosing Group v1.0

Type: object

Title: Advanced Dosing Group v1.0

Advanced Dosing Group details

Show Source

• Group criteria: array Group criteria
  Group criteria
• Group name: string
  Group name

  Example: Group A
• id: string (uuid)
  Advanced dosing group GUID
• Instructions: string
  Instructions

  Example: Group amndatory details should be provided
• Kit settings: array Kit settings
  Kit settings

{
    "title":"Advanced Dosing Group v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Advanced dosing group GUID",
            "format":"uuid"
        },
        "Group name":{
            "type":"string",
            "description":"Group name",
            "example":"Group A"
        },
        "Group criteria":{
            "type":"array",
            "description":"Group criteria",
            "items":{
                "$ref":"#/components/schemas/AdvancedDosingGroupCriteriaDtoV1"
            }
        },
        "Kit settings":{
            "type":"array",
            "description":"Kit settings",
            "items":{
                "$ref":"#/components/schemas/AdvancedDosingKitSettingsDtoV1"
            }
        },
        "Instructions":{
            "type":"string",
            "description":"Instructions",
            "example":"Group amndatory details should be provided"
        }
    },
    "description":"Advanced Dosing Group details"
}

Nested Schema : Group criteria

Type: array

Group criteria

Show Source

• Array of: object Advanced Dosing Group Criteria v1.0
  Title: Advanced Dosing Group Criteria v1.0

  Advanced Dosing Group Criteria details

{
    "type":"array",
    "description":"Group criteria",
    "items":{
        "$ref":"#/components/schemas/AdvancedDosingGroupCriteriaDtoV1"
    }
}

Nested Schema : Kit settings

Type: array

Kit settings

Show Source

• Array of: object Advanced Dosing Kit Settings v1.0
  Title: Advanced Dosing Kit Settings v1.0

  Advanced Dosing Kit Settings details

{
    "type":"array",
    "description":"Kit settings",
    "items":{
        "$ref":"#/components/schemas/AdvancedDosingKitSettingsDtoV1"
    }
}

Nested Schema : Advanced Dosing Group Criteria v1.0

Type: object

Title: Advanced Dosing Group Criteria v1.0

Advanced Dosing Group Criteria details

Show Source

• Answer: array Answer
  Answer for choice question name
• Criteria type value: string
  Allowed Values: [ "Question", "Dates", "Cohort", "Treatment Arm", "invalid" ]

  Criteria type value

  Example: Variable
• Date Value: string
  Date Value for variable

  Example: 2023-03-15
• Form name: string
  Form name

  Example: Demographics
• formId: string (uuid)
  Form GUID
• id: string (uuid)
  Group Criteria GUID
• Question name: string
  Question name

  Example: Gender
• questionId: string (uuid)
  Question GUID
• rule: object Advanced Dosing Rule v1.0
  Title: Advanced Dosing Rule v1.0

  Advanced Dosing rule details
• timePeriod: string
  Timeframe for variable

  Example: Before
• Variable type value: string
  Variable type value

  Example: System Screening Date
• variableId: string (uuid)
  Variable codelist GUID
• Visit name: string
  Visit name

  Example: Screening
• visitId: string (uuid)
  Visit GUID

{
    "title":"Advanced Dosing Group Criteria v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Group Criteria GUID",
            "format":"uuid"
        },
        "Criteria type value":{
            "type":"string",
            "description":"Criteria type value",
            "example":"Variable",
            "enum":[
                "Question",
                "Dates",
                "Cohort",
                "Treatment Arm",
                "invalid"
            ]
        },
        "Visit name":{
            "type":"string",
            "description":"Visit name",
            "example":"Screening"
        },
        "visitId":{
            "type":"string",
            "description":"Visit GUID",
            "format":"uuid"
        },
        "Form name":{
            "type":"string",
            "description":"Form name",
            "example":"Demographics"
        },
        "formId":{
            "type":"string",
            "description":"Form GUID",
            "format":"uuid"
        },
        "Question name":{
            "type":"string",
            "description":"Question name",
            "example":"Gender"
        },
        "questionId":{
            "type":"string",
            "description":"Question GUID",
            "format":"uuid"
        },
        "Variable type value":{
            "type":"string",
            "description":"Variable type value",
            "example":"System Screening Date"
        },
        "variableId":{
            "type":"string",
            "description":"Variable codelist GUID",
            "format":"uuid"
        },
        "timePeriod":{
            "type":"string",
            "description":"Timeframe for variable",
            "example":"Before"
        },
        "Date Value":{
            "type":"string",
            "description":"Date Value for variable",
            "example":"2023-03-15"
        },
        "Answer":{
            "type":"array",
            "description":"Answer for choice question name",
            "example":"Female",
            "items":{
                "$ref":"#/components/schemas/GenericAttributeDtoV1"
            }
        },
        "rule":{
            "$ref":"#/components/schemas/AdvancedDosingRuleDtoV1"
        }
    },
    "description":"Advanced Dosing Group Criteria details"
}

Nested Schema : Answer

Type: array

Answer for choice question name

Show Source

• Array of: object Generic Attribute v1.0
  Title: Generic Attribute v1.0

  Generic attribute name, value and label details

{
    "type":"array",
    "description":"Answer for choice question name",
    "example":"Female",
    "items":{
        "$ref":"#/components/schemas/GenericAttributeDtoV1"
    }
}

Example:

Female

Nested Schema : Advanced Dosing Rule v1.0

Type: object

Title: Advanced Dosing Rule v1.0

Advanced Dosing rule details

Show Source

• id: string (uuid)
  Rule Unique GUID
• lower: object RangeRuleValues
  Range rule upper boundary details
• Rule value: string
  Rule value

  Example: 2
• Rule value list: string
  Rule value list
• ruleName: string
  Rule name

  Example: Greater Than Or Equal To
• upper: object RangeRuleValues
  Range rule upper boundary details

{
    "title":"Advanced Dosing Rule v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Rule Unique GUID",
            "format":"uuid"
        },
        "ruleName":{
            "type":"string",
            "description":"Rule name",
            "example":"Greater Than Or Equal To"
        },
        "Rule value":{
            "type":"string",
            "description":"Rule value",
            "example":"2"
        },
        "Rule value list":{
            "type":"string",
            "description":"Rule value list"
        },
        "lower":{
            "$ref":"#/components/schemas/RangeRuleValues"
        },
        "upper":{
            "$ref":"#/components/schemas/RangeRuleValues"
        }
    },
    "description":"Advanced Dosing rule details"
}

Nested Schema : Generic Attribute v1.0

Type: object

Title: Generic Attribute v1.0

Generic attribute name, value and label details

Show Source

• label: string
  Attribute label

  Example: Cohort1
• value: string
  Attribute value. For example, Cohort1 UUID

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"Generic Attribute v1.0",
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"Attribute value. For example, Cohort1 UUID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"Attribute label",
            "example":"Cohort1"
        }
    },
    "description":"Generic attribute name, value and label details",
    "example":"Female"
}

Example:

Female

Nested Schema : RangeRuleValues

Type: object

Range rule upper boundary details

Show Source

• inclusive: boolean
  Flag that indicates whether boundary condition value is inclusive while consideration

  Example: true
• value: string
  Boundary value for range

  Example: 1

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"Boundary value for range",
            "example":"1"
        },
        "inclusive":{
            "type":"boolean",
            "description":"Flag that indicates whether boundary condition value is inclusive while consideration",
            "example":true
        }
    },
    "description":"Range rule upper boundary details"
}

Nested Schema : Advanced Dosing Kit Settings v1.0

Type: object

Title: Advanced Dosing Kit Settings v1.0

Advanced Dosing Kit Settings details

Show Source

• Dosing Label: string
  Dosing Label

  Example: Dose3
• dosingId: string (uuid)
  Dosing GUID
• dosings: array dosings
  Calculated dosing definitions for the kit
• id: string (uuid)
  Kits settings GUID
• Kit name: string
  Kit name

  Example: Kit a
• kitid: string (uuid)
  Kit GUID
• kitUnitSettings: object KitUnitSettingsDto v10.0
  Title: KitUnitSettingsDto v10.0

  Contains unit settings information on the kit.
• quantity: integer (int64)
  Kit quantity or dose.

  Example: 1

{
    "title":"Advanced Dosing Kit Settings v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Kits settings GUID",
            "format":"uuid"
        },
        "kitid":{
            "type":"string",
            "description":"Kit GUID",
            "format":"uuid"
        },
        "Kit name":{
            "type":"string",
            "description":"Kit name",
            "example":"Kit a"
        },
        "dosingId":{
            "type":"string",
            "description":"Dosing GUID",
            "format":"uuid"
        },
        "kitUnitSettings":{
            "$ref":"#/components/schemas/KitUnitSettingsDtoV10"
        },
        "dosings":{
            "type":"array",
            "description":"Calculated dosing definitions for the kit",
            "items":{
                "$ref":"#/components/schemas/KitDosingDtoV10"
            }
        },
        "Dosing Label":{
            "type":"string",
            "description":"Dosing Label",
            "example":"Dose3"
        },
        "quantity":{
            "type":"integer",
            "description":"Kit quantity or dose.",
            "format":"int64",
            "example":1
        }
    },
    "description":"Advanced Dosing Kit Settings details"
}

Nested Schema : dosings

Type: array

Calculated dosing definitions for the kit

Show Source

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

  Information on a calculated dose.

{
    "type":"array",
    "description":"Calculated dosing definitions for the kit",
    "items":{
        "$ref":"#/components/schemas/KitDosingDtoV10"
    }
}

Nested Schema : KitUnitSettingsDto v10.0

Type: object

Title: KitUnitSettingsDto v10.0

Contains unit settings information on the kit.

Show Source

• singleUnitDose: object KitDosingValueUnitsDto v10.0
  Title: KitDosingValueUnitsDto v10.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 v10.0",
    "type":"object",
    "properties":{
        "unitsPerKit":{
            "type":"number",
            "description":"The number of units per kit",
            "format":"double",
            "example":20
        },
        "singleUnitDose":{
            "$ref":"#/components/schemas/KitDosingValueUnitsDtoV10"
        }
    },
    "description":"Contains unit settings information on the kit."
}

Nested Schema : KitDosingDto v10.0

Type: object

Title: KitDosingDto v10.0

Information on a calculated dose.

Show Source

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

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

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

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

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

  Visit information on the calculated dose.

{
    "title":"KitDosingDto v10.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/KitDosingQuestionDtoV10"
        },
        "visit":{
            "$ref":"#/components/schemas/KitDosingVisitDtoV10"
        },
        "dose":{
            "$ref":"#/components/schemas/KitDosingDoseDtoV10"
        },
        "measurement":{
            "$ref":"#/components/schemas/KitDosingMeasurementDtoV10"
        }
    },
    "description":"Information on a calculated dose."
}

Nested Schema : KitDosingDoseDto v10.0

Type: object

Title: KitDosingDoseDto v10.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)
• roundUp: integer (int32)
  Rounded up for dosing calculation

  Example: 1

{
    "title":"KitDosingDoseDto v10.0",
    "type":"object",
    "properties":{
        "precision":{
            "type":"integer",
            "format":"int32"
        },
        "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 v10.0

Type: object

Title: KitDosingMeasurementDto v10.0

Kit and subject measurement information on a calculated dose.

Show Source

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

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

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

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

Nested Schema : KitDosingQuestionDto v10.0

Type: object

Title: KitDosingQuestionDto v10.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 v10.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 v10.0

Type: object

Title: KitDosingVisitDto v10.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 v10.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 v10.0

Type: object

Title: KitDosingValueUnitsDto v10.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 v10.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 : KitDosingDto v8.0

Type: object

Title: KitDosingDto v8.0

Information on a calculated dose.

Show Source

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

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

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

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

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

  Visit information on the calculated dose.

{
    "title":"KitDosingDto v8.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/KitDosingQuestionDtoV8"
        },
        "visit":{
            "$ref":"#/components/schemas/KitDosingVisitDtoV8"
        },
        "dose":{
            "$ref":"#/components/schemas/KitDosingDoseDtoV8"
        },
        "measurement":{
            "$ref":"#/components/schemas/KitDosingMeasurementDtoV8"
        }
    },
    "description":"Information on a calculated dose."
}

Nested Schema : KitDosingDoseDto v8.0

Type: object

Title: KitDosingDoseDto v8.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)
• roundUp: integer (int32)
  Rounded up for dosing calculation

  Example: 1

{
    "title":"KitDosingDoseDto v8.0",
    "type":"object",
    "properties":{
        "precision":{
            "type":"integer",
            "format":"int32"
        },
        "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 v8.0

Type: object

Title: KitDosingMeasurementDto v8.0

Kit and subject measurement information on a calculated dose.

Show Source

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

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

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

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

Nested Schema : KitDosingQuestionDto v8.0

Type: object

Title: KitDosingQuestionDto v8.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 v8.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 v8.0

Type: object

Title: KitDosingVisitDto v8.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 v8.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 v8.0

Type: object

Title: KitDosingValueUnitsDto v8.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 v8.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 v8.0

Type: object

Title: KitTitrationsDto v8.0

Contains titrations information on the titration kit.

Show Source

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

  Titration Kit Items
• maintainTitrationKitJson: object TitrationKitItemsDto v8.0
  Title: TitrationKitItemsDto v8.0

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

  Titration Kit Items
• titrationKitLabel: string
  Custom optional Dose Level title to indicate a dose level for a row within a Titration Group

  Example: Low Dose
• titrationKitSeq: integer (int64)
  Sequence number of the current titration row within the kit

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

  Titration Kit Items

{
    "title":"KitTitrationsDto v8.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"
        },
        "titrationKitLabel":{
            "type":"string",
            "description":"Custom optional Dose Level title to indicate a dose level for a row within a Titration Group",
            "example":"Low Dose"
        },
        "titrationKitSeq":{
            "type":"integer",
            "description":"Sequence number of the current titration row within the kit",
            "format":"int64",
            "example":5
        },
        "titrationKitJson":{
            "$ref":"#/components/schemas/TitrationKitItemsDtoV8"
        },
        "upTitrationKitJson":{
            "$ref":"#/components/schemas/TitrationKitItemsDtoV8"
        },
        "maintainTitrationKitJson":{
            "$ref":"#/components/schemas/TitrationKitItemsDtoV8"
        },
        "downTitrationKitJson":{
            "$ref":"#/components/schemas/TitrationKitItemsDtoV8"
        }
    },
    "description":"Contains titrations information on the titration kit."
}

Nested Schema : TitrationKitItemsDto v8.0

Type: object

Title: TitrationKitItemsDto v8.0

Titration Kit Items

Show Source

• titrationKitItems: array titrationKitItems

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

Nested Schema : titrationKitItems

Type: array

Show Source

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

  Titration Kit Item

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

Nested Schema : TitrationKitItemDto v8.0

Type: object

Title: TitrationKitItemDto v8.0

Titration Kit Item

Show Source

• dosageId: string
  Dosage Id

  Example: B1B8327AFAA6412287106192AB5984EF
• kitDosage: string
  Kit Dosage

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

  Example: 1

{
    "title":"TitrationKitItemDto v8.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"
        },
        "dosageId":{
            "type":"string",
            "description":"Dosage Id",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        }
    },
    "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