Jump to

• Request
• Response

[Deprecated]: V2.0

post

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

Deprecated: Use latest version instead. Creates a new kit type in a study.

Request

Path Parameters

• 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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : KitDto v2.0

Type: object

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

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

{
    "title":"KitDto v2.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "kitid":{
            "type":"string",
            "description":"Kit GUID",
            "format":"uuid"
        },
        "kitSettings":{
            "$ref":"#/components/schemas/KitSettingsDtoV2"
        },
        "kitUnitSettings":{
            "$ref":"#/components/schemas/KitUnitSettingsDtoV2"
        },
        "dosings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KitDosingDtoV2"
            }
        },
        "dosage":{
            "type":"number",
            "description":"Dosage.",
            "format":"double",
            "example":50
        },
        "isDefault":{
            "type":"boolean",
            "description":"Is kit default.",
            "example":true
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "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 v2.0
  Title: KitDosingDto v2.0

  Information on a calculated dose.

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

Nested Schema : KitSettingsDto v2.0

Type: object

Title: KitSettingsDto v2.0

Contains settings information on the kit.

Show Source

• calculatingDoses: boolean
  Indicates if the kit has calculating doses

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

  Example: BLINDED
• kitDescription: string
  The kit description

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

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

  Example: 10
• storageSetting: string
  The storage temperature

  Example: AMBIENT
• trialSupplyType: string
  The kit type

  Example: BOTTLE

{
    "title":"KitSettingsDto v2.0",
    "type":"object",
    "properties":{
        "calculatingDoses":{
            "type":"boolean",
            "description":"Indicates if the kit has calculating doses",
            "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
        }
    },
    "description":"Contains settings information on the kit."
}

Nested Schema : KitUnitSettingsDto v2.0

Type: object

Title: KitUnitSettingsDto v2.0

Contains unit settings information on the kit.

Show Source

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

Nested Schema : KitDosingDto v2.0

Type: object

Title: KitDosingDto v2.0

Information on a calculated dose.

Show Source

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

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

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

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

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

  Visit information on the calculated dose.

{
    "title":"KitDosingDto v2.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/KitDosingQuestionDtoV2"
        },
        "visit":{
            "$ref":"#/components/schemas/KitDosingVisitDtoV2"
        },
        "dose":{
            "$ref":"#/components/schemas/KitDosingDoseDtoV2"
        },
        "measurement":{
            "$ref":"#/components/schemas/KitDosingMeasurementDtoV2"
        }
    },
    "description":"Information on a calculated dose."
}

Nested Schema : KitDosingDoseDto v2.0

Type: object

Title: KitDosingDoseDto v2.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 v2.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 v2.0

Type: object

Title: KitDosingMeasurementDto v2.0

Kit and subject measurement information on a calculated dose.

Show Source

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

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

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

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

Nested Schema : KitDosingQuestionDto v2.0

Type: object

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

Type: object

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

Type: object

Title: KitDosingValueUnitsDto v2.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 v2.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."
}

Examples

Select an example requestExample

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : KitDto v2.0

Type: object

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

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

{
    "title":"KitDto v2.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "kitid":{
            "type":"string",
            "description":"Kit GUID",
            "format":"uuid"
        },
        "kitSettings":{
            "$ref":"#/components/schemas/KitSettingsDtoV2"
        },
        "kitUnitSettings":{
            "$ref":"#/components/schemas/KitUnitSettingsDtoV2"
        },
        "dosings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KitDosingDtoV2"
            }
        },
        "dosage":{
            "type":"number",
            "description":"Dosage.",
            "format":"double",
            "example":50
        },
        "isDefault":{
            "type":"boolean",
            "description":"Is kit default.",
            "example":true
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "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 v2.0
  Title: KitDosingDto v2.0

  Information on a calculated dose.

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

Nested Schema : KitSettingsDto v2.0

Type: object

Title: KitSettingsDto v2.0

Contains settings information on the kit.

Show Source

• calculatingDoses: boolean
  Indicates if the kit has calculating doses

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

  Example: BLINDED
• kitDescription: string
  The kit description

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

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

  Example: 10
• storageSetting: string
  The storage temperature

  Example: AMBIENT
• trialSupplyType: string
  The kit type

  Example: BOTTLE

{
    "title":"KitSettingsDto v2.0",
    "type":"object",
    "properties":{
        "calculatingDoses":{
            "type":"boolean",
            "description":"Indicates if the kit has calculating doses",
            "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
        }
    },
    "description":"Contains settings information on the kit."
}

Nested Schema : KitUnitSettingsDto v2.0

Type: object

Title: KitUnitSettingsDto v2.0

Contains unit settings information on the kit.

Show Source

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

Nested Schema : KitDosingDto v2.0

Type: object

Title: KitDosingDto v2.0

Information on a calculated dose.

Show Source

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

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

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

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

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

  Visit information on the calculated dose.

{
    "title":"KitDosingDto v2.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/KitDosingQuestionDtoV2"
        },
        "visit":{
            "$ref":"#/components/schemas/KitDosingVisitDtoV2"
        },
        "dose":{
            "$ref":"#/components/schemas/KitDosingDoseDtoV2"
        },
        "measurement":{
            "$ref":"#/components/schemas/KitDosingMeasurementDtoV2"
        }
    },
    "description":"Information on a calculated dose."
}

Nested Schema : KitDosingDoseDto v2.0

Type: object

Title: KitDosingDoseDto v2.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 v2.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 v2.0

Type: object

Title: KitDosingMeasurementDto v2.0

Kit and subject measurement information on a calculated dose.

Show Source

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

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

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

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

Nested Schema : KitDosingQuestionDto v2.0

Type: object

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

Type: object

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

Type: object

Title: KitDosingValueUnitsDto v2.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 v2.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."
}

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."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top