• kitTypes: array kitTypes
• treatmentArms: array treatmentArms

{
    "type":"object",
    "properties":{
        "treatmentArms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RandomizationHistoryTO"
            }
        },
        "kitTypes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeViewResponse.KitTypes"
            }
        }
    },
    "description":"Contains code view response details."
}

• Array of: object CodeViewResponse.KitTypes
  Kit type details object.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CodeViewResponse.KitTypes"
    }
}

• Array of: object RandomizationHistoryTO
  Contains subject randomization history details.

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

• description: string
  Kit type description.

  Example: Non dosing kit
• dispensationDetails: array dispensationDetails
• id: string
  ID of the kit type.

  Example: B1B8327AFAA6412287106192AB5984EF
• kitTypeName: string
  Kit type name.

  Example: Kit A
• packageType: string
  Allowed Values: [ "BLISTERPACK", "BOTTLE", "DEVICE", "SYRINGE", "OINTMENT", "VIAL", "INHALER", "INFUSION", "BOX", "OTHER" ]

  Package type.

  Example: INHALER
• packageTypeId: number (double)
  Allowed Values: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]

  Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).

  Example: 5

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the kit type.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "kitTypeName":{
            "type":"string",
            "description":"Kit type name.",
            "example":"Kit A"
        },
        "description":{
            "type":"string",
            "description":"Kit type description.",
            "example":"Non dosing kit"
        },
        "packageTypeId":{
            "type":"number",
            "description":"Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).",
            "format":"double",
            "example":5,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10
            ]
        },
        "packageType":{
            "type":"string",
            "description":"Package type.",
            "example":"INHALER",
            "enum":[
                "BLISTERPACK",
                "BOTTLE",
                "DEVICE",
                "SYRINGE",
                "OINTMENT",
                "VIAL",
                "INHALER",
                "INFUSION",
                "BOX",
                "OTHER"
            ]
        },
        "dispensationDetails":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DispensationHistoryResponseV4"
            }
        }
    },
    "description":"Kit type details object."
}

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

  Response object containing Dispensation History.

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

• balanceUnits: number (double)
  Balance Units of Kit

  Example: 1
• deviceConnection: string
  Allowed Values: [ "CloudtoCloud", "DevicetoCloud", "NoConnection" ]

  Indicates device connection in case of device kit

  Example: DevicetoCloud
• deviceType: string
  Allowed Values: [ "ActivityWatch", "BloodPressureMonitor", "WeightScale", "ECGReader", "Spirometer", "MobileApp", "SmartPillBottle", "PulseOximeter", "WearablePatch", "Other", "GlucoseMonitor" ]

  Indicates type of device in case of device kit

  Example: WearablePatch
• dispensationDate: string (date-time)
  Dispensation date
• dose: number (double)
  Dose.

  Example: 5
• frequency: string
  Allowed Values: [ "Once", "QD", "BID", "TID", "QID", "Q3", "Q4", "Q8", "Q12", "Q24", "Bedtime", "With meals", "With meals and at bedtime" ]

  Dosing frequency.

  Example: BID
• inventoryId: string (uuid)
  Inventory Id.
• inventoryStatus: number (double)
  Allowed Values: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20 ]

  Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).

  Example: 5
• kitDescription: string
  Kit Type Description

  Example: Kit A
• kitNumber: number (double)
  Kit nuumber.

  Example: 5
• lastModifiedDate: string (date-time)
  Last modified date
• measurement: string
  Dose Measurement.

  Example: ml
• mHealthDeviceId: string
  mHealth Device Id

  Example: B1B8327AFAA6412287106192AB5984EF
• missingUnits: number (double)
  Missing Units of Kit

  Example: 1
• packageTypeId: number (double)
  Allowed Values: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]

  Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).

  Example: 5
• returnedUnits: number (double)
  Returned Units of Kit

  Example: 1
• siteId: string (uuid)
  ID of the site
• trialSupplyType: string
  Trial Supply Type for the kit

  Example: BOTTLE
• unitsPerKit: number (double)
  Units per Kit

  Example: 1
• visitId: string (uuid)
  ID of the visit

{
    "title":"DispensationHistoryResponse v4.0",
    "type":"object",
    "properties":{
        "kitNumber":{
            "type":"number",
            "description":"Kit nuumber.",
            "format":"double",
            "example":5
        },
        "inventoryStatus":{
            "type":"number",
            "description":"Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).",
            "format":"double",
            "example":5,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10,
                11,
                12,
                13,
                14,
                15,
                16,
                17,
                18,
                19,
                20
            ]
        },
        "dispensationDate":{
            "type":"string",
            "description":"Dispensation date",
            "format":"date-time"
        },
        "inventoryId":{
            "type":"string",
            "description":"Inventory Id.",
            "format":"uuid"
        },
        "packageTypeId":{
            "type":"number",
            "description":"Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).",
            "format":"double",
            "example":5,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10
            ]
        },
        "unitsPerKit":{
            "type":"number",
            "description":"Units per Kit",
            "format":"double",
            "example":1
        },
        "returnedUnits":{
            "type":"number",
            "description":"Returned Units of Kit",
            "format":"double",
            "example":1
        },
        "missingUnits":{
            "type":"number",
            "description":"Missing Units of Kit",
            "format":"double",
            "example":1
        },
        "balanceUnits":{
            "type":"number",
            "description":"Balance Units of Kit",
            "format":"double",
            "example":1
        },
        "siteId":{
            "type":"string",
            "description":"ID  of the site",
            "format":"uuid"
        },
        "lastModifiedDate":{
            "type":"string",
            "description":"Last modified date",
            "format":"date-time"
        },
        "kitDescription":{
            "type":"string",
            "description":"Kit Type Description",
            "example":"Kit A"
        },
        "dose":{
            "type":"number",
            "description":"Dose.",
            "format":"double",
            "example":5
        },
        "measurement":{
            "type":"string",
            "description":"Dose Measurement.",
            "example":"ml"
        },
        "frequency":{
            "type":"string",
            "description":"Dosing frequency.",
            "example":"BID",
            "enum":[
                "Once",
                "QD",
                "BID",
                "TID",
                "QID",
                "Q3",
                "Q4",
                "Q8",
                "Q12",
                "Q24",
                "Bedtime",
                "With meals",
                "With meals and at bedtime"
            ]
        },
        "visitId":{
            "type":"string",
            "description":"ID of the visit",
            "format":"uuid"
        },
        "trialSupplyType":{
            "type":"string",
            "description":"Trial Supply Type for the kit",
            "example":"BOTTLE"
        },
        "deviceType":{
            "type":"string",
            "description":"Indicates type of device in case of device kit",
            "example":"WearablePatch",
            "enum":[
                "ActivityWatch",
                "BloodPressureMonitor",
                "WeightScale",
                "ECGReader",
                "Spirometer",
                "MobileApp",
                "SmartPillBottle",
                "PulseOximeter",
                "WearablePatch",
                "Other",
                "GlucoseMonitor"
            ]
        },
        "deviceConnection":{
            "type":"string",
            "description":"Indicates device connection in case of device kit",
            "example":"DevicetoCloud",
            "enum":[
                "CloudtoCloud",
                "DevicetoCloud",
                "NoConnection"
            ]
        },
        "mHealthDeviceId":{
            "type":"string",
            "description":"mHealth Device Id",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        }
    },
    "description":"Response object containing Dispensation History."
}

• description: string
  Treatment description

  Example: Some description.
• externalTreatmentId: string
  External treatment Id.

  Example: TxA.
• id: string (uuid)
  Treatment ID
• randNumber: number (double)
  Randomization number.

  Example: 5
• randomizationDate: string (date-time)
  Randomization date.
• rndStatusId: number (double)
  Allowed Values: [ 1, 2, 3, 4, 5 ]

  Unique ID corresponding to each Randomization status value (1 for Not Approved, 2 for Available, 3 for Not Released, 4 for Assigned, 5 for Randomized in Error).

  Example: 5

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Treatment ID",
            "format":"uuid"
        },
        "description":{
            "type":"string",
            "description":"Treatment description",
            "example":"Some description."
        },
        "externalTreatmentId":{
            "type":"string",
            "description":"External treatment Id.",
            "example":"TxA."
        },
        "randNumber":{
            "type":"number",
            "description":"Randomization number.",
            "format":"double",
            "example":5
        },
        "randomizationDate":{
            "type":"string",
            "description":"Randomization date.",
            "format":"date-time"
        },
        "rndStatusId":{
            "type":"number",
            "description":"Unique ID corresponding to each Randomization status value (1 for Not Approved, 2 for Available, 3 for Not Released, 4 for Assigned, 5 for Randomized in Error).",
            "format":"double",
            "example":5,
            "enum":[
                1,
                2,
                3,
                4,
                5
            ]
        }
    },
    "description":"Contains subject randomization history details."
}

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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