Jump to

• Request
• Response

[Deprecated]: Update a kit

put

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

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

Request

Path Parameters

• kitId(required): string
  The kit id
• studyId(required): string(uuid)
  Study ID. Example: F054C951EB74443C93716CA714AB686E
• version(required): string
  Study version. Example: "1.0.0.1"

Supported Media Types

• */*

Request Body - */* ()

Root Schema : KitsDto

Type: object

Title: KitsDto

Information about a kit.

Show Source

• advancedDosing: integer (int32)
• dosage: number (double)
• dosings: array dosings
• exceptions: array exceptions
• groups: array groups
• id: string (uuid)
• isDefault: boolean
• kitId: string (uuid)
• kitSettings: object KitSettingsDto
• kitTitrations: array kitTitrations
• kitUnitSettings: object KitUnitSettingsDto
• libraryKitId: string (uuid)
• poolingId: string
• studyId: string (uuid)
• studyVersionEnd: string (date-time)
• studyVersionStart: string (date-time)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "title":"KitsDto",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "kitId":{
            "type":"string",
            "format":"uuid"
        },
        "kitSettings":{
            "$ref":"#/components/schemas/KitSettingsDto"
        },
        "kitUnitSettings":{
            "$ref":"#/components/schemas/KitUnitSettingsDto"
        },
        "kitTitrations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KitTitrationsDto"
            }
        },
        "dosings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KitDosingDto"
            }
        },
        "dosage":{
            "type":"number",
            "format":"double"
        },
        "isDefault":{
            "type":"boolean"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "format":"date-time"
        },
        "studyVersionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "exceptions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KitTitrationsDtoV5"
            }
        },
        "advancedDosing":{
            "type":"integer",
            "format":"int32"
        },
        "groups":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AdvancedDosingGroupDto"
            }
        },
        "libraryKitId":{
            "type":"string",
            "format":"uuid"
        },
        "poolingId":{
            "type":"string"
        }
    },
    "description":"Information about a kit."
}

Nested Schema : dosings

Type: array

Show Source

• Array of: object KitDosingDto

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

Nested Schema : exceptions

Type: array

Show Source

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

  Contains titrations information on the titration kit.

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

Nested Schema : groups

Type: array

Show Source

• Array of: object AdvancedDosingGroupDto

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

Nested Schema : KitSettingsDto

Type: object

Show Source

• bufferdays: integer (int64)
• calculatingDoses: boolean
• controlSubstance: boolean
• deviceConn: string
• deviceType: string
• dispenseOnHighestDose: boolean
• dispenseOnHighestDoseMsg: string
• dispenseOnLowestDose: boolean
• dispenseOnLowestDoseMsg: string
• dispenseOutsideWindow: boolean
• distributionSetting: string
• doseChangeInUnschVisit: boolean
• downTitrateDose: integer (int64)
• downTitrateDoseUnscheduled: integer (int64)
• hazardousMaterial: boolean
• kitDescription: string
• kitTypeId: string
• maxDoseChanges: integer (int64)
• minShipUnits: integer (int64)
• serialized: boolean
• storageSetting: string
• timeBetweenDownDoseChanges: integer (int64)
• timeBetweenDownDoseChangesException: boolean
• timeBetweenDownDoseChangesUnit: string
• timeBetweenUpDoseChanges: integer (int64)
• timeBetweenUpDoseChangesException: boolean
• timeBetweenUpDoseChangesUnit: string
• titratingDoses: boolean
• titrationKit: boolean
• totalDoseUnscheduled: integer (int64)
• trialSupplyType: string
• upTitrateDose: integer (int64)
• upTitrateDoseUnscheduled: integer (int64)

{
    "type":"object",
    "properties":{
        "deviceType":{
            "type":"string"
        },
        "deviceConn":{
            "type":"string"
        },
        "calculatingDoses":{
            "type":"boolean"
        },
        "titratingDoses":{
            "type":"boolean"
        },
        "titrationKit":{
            "type":"boolean"
        },
        "distributionSetting":{
            "type":"string"
        },
        "kitTypeId":{
            "type":"string"
        },
        "kitDescription":{
            "type":"string"
        },
        "storageSetting":{
            "type":"string"
        },
        "trialSupplyType":{
            "type":"string"
        },
        "minShipUnits":{
            "type":"integer",
            "format":"int64"
        },
        "serialized":{
            "type":"boolean"
        },
        "hazardousMaterial":{
            "type":"boolean"
        },
        "controlSubstance":{
            "type":"boolean"
        },
        "bufferdays":{
            "type":"integer",
            "format":"int64"
        },
        "dispenseOutsideWindow":{
            "type":"boolean"
        },
        "doseChangeInUnschVisit":{
            "type":"boolean"
        },
        "maxDoseChanges":{
            "type":"integer",
            "format":"int64"
        },
        "upTitrateDose":{
            "type":"integer",
            "format":"int64"
        },
        "downTitrateDose":{
            "type":"integer",
            "format":"int64"
        },
        "totalDoseUnscheduled":{
            "type":"integer",
            "format":"int64"
        },
        "upTitrateDoseUnscheduled":{
            "type":"integer",
            "format":"int64"
        },
        "downTitrateDoseUnscheduled":{
            "type":"integer",
            "format":"int64"
        },
        "timeBetweenUpDoseChangesUnit":{
            "type":"string"
        },
        "timeBetweenUpDoseChanges":{
            "type":"integer",
            "format":"int64"
        },
        "timeBetweenUpDoseChangesException":{
            "type":"boolean"
        },
        "timeBetweenDownDoseChangesUnit":{
            "type":"string"
        },
        "timeBetweenDownDoseChanges":{
            "type":"integer",
            "format":"int64"
        },
        "timeBetweenDownDoseChangesException":{
            "type":"boolean"
        },
        "dispenseOnHighestDose":{
            "type":"boolean"
        },
        "dispenseOnLowestDose":{
            "type":"boolean"
        },
        "dispenseOnHighestDoseMsg":{
            "type":"string"
        },
        "dispenseOnLowestDoseMsg":{
            "type":"string"
        }
    }
}

Nested Schema : kitTitrations

Type: array

Show Source

• Array of: object KitTitrationsDto

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

Nested Schema : KitUnitSettingsDto

Type: object

Show Source

• singleUnitDose: object KitDosingValueUnitsDto
• unitsPerKit: number

{
    "type":"object",
    "properties":{
        "unitsPerKit":{
            "type":"number"
        },
        "singleUnitDose":{
            "$ref":"#/components/schemas/KitDosingValueUnitsDto"
        }
    }
}

Nested Schema : KitDosingDto

Type: object

Show Source

• dose: object KitDosingDoseDto
• id: string (uuid)
• measurement: object KitDosingMeasurementDto
• name: string
• question: object KitDosingQuestionDto
• visit: object KitDosingVisitDto

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "question":{
            "$ref":"#/components/schemas/KitDosingQuestionDto"
        },
        "visit":{
            "$ref":"#/components/schemas/KitDosingVisitDto"
        },
        "dose":{
            "$ref":"#/components/schemas/KitDosingDoseDto"
        },
        "measurement":{
            "$ref":"#/components/schemas/KitDosingMeasurementDto"
        }
    }
}

Nested Schema : KitDosingDoseDto

Type: object

Show Source

• frequency: string
• leftOverUnits: boolean
• precision: integer (int32)
• roundUp: integer (int32)

{
    "type":"object",
    "properties":{
        "precision":{
            "type":"integer",
            "format":"int32"
        },
        "roundUp":{
            "type":"integer",
            "format":"int32"
        },
        "frequency":{
            "type":"string"
        },
        "leftOverUnits":{
            "type":"boolean"
        }
    }
}

Nested Schema : KitDosingMeasurementDto

Type: object

Show Source

• kit: object KitDosingValueUnitsDto
• subject: object KitDosingValueUnitsDto

{
    "type":"object",
    "properties":{
        "kit":{
            "$ref":"#/components/schemas/KitDosingValueUnitsDto"
        },
        "subject":{
            "$ref":"#/components/schemas/KitDosingValueUnitsDto"
        }
    }
}

Nested Schema : KitDosingQuestionDto

Type: object

Show Source

• formId: string (uuid)
• itemId: string (uuid)

{
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "format":"uuid"
        },
        "itemId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : KitDosingVisitDto

Type: object

Show Source

• id: string (uuid)
• type: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : KitDosingValueUnitsDto

Type: object

Show Source

• units: string
• value: number (double)

{
    "type":"object",
    "properties":{
        "value":{
            "type":"number",
            "format":"double"
        },
        "units":{
            "type":"string"
        }
    }
}

Nested Schema : KitTitrationsDto v5.0

Type: object

Title: KitTitrationsDto v5.0

Contains titrations information on the titration kit.

Show Source

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

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

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

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

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

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

  Titration Kit Items

{
    "title":"KitTitrationsDto v5.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/TitrationKitItemsDtoV5"
        },
        "upTitrationKitJson":{
            "$ref":"#/components/schemas/TitrationKitItemsDtoV5"
        },
        "maintainTitrationKitJson":{
            "$ref":"#/components/schemas/TitrationKitItemsDtoV5"
        },
        "downTitrationKitJson":{
            "$ref":"#/components/schemas/TitrationKitItemsDtoV5"
        }
    },
    "description":"Contains titrations information on the titration kit."
}

Nested Schema : TitrationKitItemsDto v5.0

Type: object

Title: TitrationKitItemsDto v5.0

Titration Kit Items

Show Source

• titrationKitItems: array titrationKitItems

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

Nested Schema : titrationKitItems

Type: array

Show Source

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

  Titration Kit Item

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

Nested Schema : TitrationKitItemDto v5.0

Type: object

Title: TitrationKitItemDto v5.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 v5.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"
}

Nested Schema : AdvancedDosingGroupDto

Type: object

Show Source

• groupCriteria: array groupCriteria
• groupName: string
• id: string (uuid)
• instructions: string
• kitSettings: array kitSettings

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "groupName":{
            "type":"string"
        },
        "groupCriteria":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AdvancedDosingGroupCriteriaDto"
            }
        },
        "kitSettings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AdvancedDosingKitSettingsDto"
            }
        },
        "instructions":{
            "type":"string"
        }
    }
}

Nested Schema : groupCriteria

Type: array

Show Source

• Array of: object AdvancedDosingGroupCriteriaDto

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

Nested Schema : kitSettings

Type: array

Show Source

• Array of: object AdvancedDosingKitSettingsDto

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

Nested Schema : AdvancedDosingGroupCriteriaDto

Type: object

Show Source

• answer: array answer
• criteriaType: string
  Allowed Values: [ "Question", "Dates", "Cohort", "invalid" ]
• dateValue: string
• formId: string (uuid)
• formName: string
• id: string (uuid)
• questionId: string (uuid)
• questionName: string
• rule: object AdvancedDosingRuleDto
• timePeriod: string
  Allowed Values: [ "After", "Before", "invalid" ]
• variable: string
• variableId: string (uuid)
• visitId: string (uuid)
• visitName: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "criteriaType":{
            "type":"string",
            "enum":[
                "Question",
                "Dates",
                "Cohort",
                "invalid"
            ]
        },
        "visitName":{
            "type":"string"
        },
        "visitId":{
            "type":"string",
            "format":"uuid"
        },
        "formName":{
            "type":"string"
        },
        "formId":{
            "type":"string",
            "format":"uuid"
        },
        "questionName":{
            "type":"string"
        },
        "questionId":{
            "type":"string",
            "format":"uuid"
        },
        "variable":{
            "type":"string"
        },
        "variableId":{
            "type":"string",
            "format":"uuid"
        },
        "timePeriod":{
            "type":"string",
            "enum":[
                "After",
                "Before",
                "invalid"
            ]
        },
        "dateValue":{
            "type":"string"
        },
        "answer":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CommonAttributeDto"
            }
        },
        "rule":{
            "$ref":"#/components/schemas/AdvancedDosingRuleDto"
        }
    }
}

Nested Schema : answer

Type: array

Show Source

• Array of: object CommonAttributeDto

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

Nested Schema : AdvancedDosingRuleDto

Type: object

Show Source

• id: string (uuid)
• lower: object RangeRuleValues
  Range rule upper boundary details
• ruleName: string
• upper: object RangeRuleValues
  Range rule upper boundary details
• value: string
• valueList: array valueList

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "ruleName":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "valueList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CommonAttributeDto"
            }
        },
        "lower":{
            "$ref":"#/components/schemas/RangeRuleValues"
        },
        "upper":{
            "$ref":"#/components/schemas/RangeRuleValues"
        }
    }
}

Nested Schema : CommonAttributeDto

Type: object

Show Source

• label: string
• value: string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "label":{
            "type":"string"
        }
    }
}

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 : valueList

Type: array

Show Source

• Array of: object CommonAttributeDto

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

Nested Schema : AdvancedDosingKitSettingsDto

Type: object

Show Source

• dosingId: string (uuid)
• dosingLabel: string
• id: string (uuid)
• kitId: string (uuid)
• kitName: string
• quantity: integer (int64)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "kitId":{
            "type":"string",
            "format":"uuid"
        },
        "kitName":{
            "type":"string"
        },
        "dosingId":{
            "type":"string",
            "format":"uuid"
        },
        "dosingLabel":{
            "type":"string"
        },
        "quantity":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : KitTitrationsDto

Type: object

Show Source

• downTitrationKitJson: object TitrationKitItemsDto
  Titration Kit Items
• maintainTitrationKitJson: object TitrationKitItemsDto
  Titration Kit Items
• rowId: string (uuid)
• titrationKitJson: object TitrationKitItemsDto
  Titration Kit Items
• titrationKitLabel: string
• titrationKitSeq: integer (int64)
• upTitrationKitJson: object TitrationKitItemsDto
  Titration Kit Items

{
    "type":"object",
    "properties":{
        "rowId":{
            "type":"string",
            "format":"uuid"
        },
        "titrationKitLabel":{
            "type":"string"
        },
        "titrationKitSeq":{
            "type":"integer",
            "format":"int64"
        },
        "titrationKitJson":{
            "$ref":"#/components/schemas/TitrationKitItemsDto"
        },
        "upTitrationKitJson":{
            "$ref":"#/components/schemas/TitrationKitItemsDto"
        },
        "maintainTitrationKitJson":{
            "$ref":"#/components/schemas/TitrationKitItemsDto"
        },
        "downTitrationKitJson":{
            "$ref":"#/components/schemas/TitrationKitItemsDto"
        }
    }
}

Nested Schema : TitrationKitItemsDto

Type: object

Titration Kit Items

Show Source

• titrationKitItems: object TitrationKitItemDto
  Title: TitrationKitItemDto

  Titration Kit Item

{
    "type":"object",
    "properties":{
        "titrationKitItems":{
            "$ref":"#/components/schemas/TitrationKitItemDTO"
        }
    },
    "description":"Titration Kit Items"
}

Nested Schema : TitrationKitItemDto

Type: object

Title: TitrationKitItemDto

Titration Kit Item

Show Source

• dosageId: string
  Dosage Id

  Example: B1B8327AFAA6412287106192AB5984EF
• kitDosage: string
  Kit Dosage

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

  Example: 1

{
    "title":"TitrationKitItemDto",
    "type":"object",
    "properties":{
        "kitId":{
            "type":"string",
            "description":"Kit Unique 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"
}

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."
}

500 Response

Error

Body ()

Root Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : details

Type: object

Back to Top