REST API for Clinical One Platform

Get titration dispensation data

get

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

Retrieves all data needed to define dispensation of kit type titration. For example, list of assignable visits, treatment arms and randomization designs.

Request

Path Parameters

kitId(required): string(uuid)

Kit identifier
studyId(required): string(uuid)

Study ID. Example: F054C951EB74443C93716CA714AB686E
version(required): string

Study version. Example: "1.0.0.1"
visitId(required): string(uuid)

Visit identifier

Query Parameters

branchIds(required): string

Branch IDs in the visits schedule

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : schema

Type: array

Show Source

Array of: object VisitDesignDto v2.0

Title: VisitDesignDto v2.0

Visit Design Information

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

Nested Schema : VisitDesignDto v2.0

Type: object

Title: VisitDesignDto v2.0

Visit Design Information

Show Source

dispensings: object VisitDesignDispensingDto v2.0

Title: VisitDesignDispensingDto v2.0

Visit design dispensings.
eventType: string

Visit Design event type

Example: ScreeningVisit
forms: object VisitDesignAssignedFormsDto v2.0

Title: VisitDesignAssignedFormsDto v2.0

Visit design assigned forms.
id: string (uuid)

Visit Design unique GUID
randomization: object VisitDesignRandomizationDto v2.0

Title: VisitDesignRandomizationDto v2.0

Visit design randomization.
scheduling: object VisitDesignSchedulingDto v2.0

Title: VisitDesignSchedulingDto v2.0

Visit design scheduling.
shortName: string

Visit Design short name

Example: Week1
state: object VisitDesignStateDto v2.0

Title: VisitDesignStateDto v2.0

Visit design state.
title: string

Visit design title

Example: Week1

{
    "title":"VisitDesignDto v2.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit Design unique GUID",
            "format":"uuid"
        },
        "title":{
            "type":"string",
            "description":"Visit design title",
            "example":"Week1"
        },
        "eventType":{
            "type":"string",
            "description":"Visit Design event type",
            "example":"ScreeningVisit"
        },
        "shortName":{
            "type":"string",
            "description":"Visit Design short name",
            "example":"Week1"
        },
        "state":{
            "$ref":"#/components/schemas/VisitDesignStateDtoV2"
        },
        "scheduling":{
            "$ref":"#/components/schemas/VisitDesignSchedulingDtoV2"
        },
        "randomization":{
            "$ref":"#/components/schemas/VisitDesignRandomizationDtoV2"
        },
        "forms":{
            "$ref":"#/components/schemas/VisitDesignAssignedFormsDtoV2"
        },
        "dispensings":{
            "$ref":"#/components/schemas/VisitDesignDispensingDtoV2"
        }
    },
    "description":"Visit Design Information"
}

Nested Schema : VisitDesignDispensingDto v2.0

Type: object

Title: VisitDesignDispensingDto v2.0

Visit design dispensings.

Show Source

count: integer (int32)

Visit Design dispensing count

Example: 1
titrationCount: integer (int32)

Visit Design titration count

Example: 1

{
    "title":"VisitDesignDispensingDto v2.0",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"Visit Design dispensing count",
            "format":"int32",
            "example":1
        },
        "titrationCount":{
            "type":"integer",
            "description":"Visit Design titration count",
            "format":"int32",
            "example":1
        }
    },
    "description":"Visit design dispensings."
}

Nested Schema : VisitDesignAssignedFormsDto v2.0

Type: object

Title: VisitDesignAssignedFormsDto v2.0

Visit design assigned forms.

Show Source

count: integer (int32)

Count of the forms assigned to the visit

Example: 1

{
    "title":"VisitDesignAssignedFormsDto v2.0",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"Count of the forms assigned to the visit",
            "format":"int32",
            "example":1
        }
    },
    "description":"Visit design assigned forms."
}

Nested Schema : VisitDesignRandomizationDto v2.0

Type: object

Title: VisitDesignRandomizationDto v2.0

Visit design randomization.

Show Source

algorithm: string

Visit Design allow randomization algorithm type

Example: Central
id: string (uuid)

Visit Design randomization unique GUID
treatmentArms: string

Visit Design allow randomization treatment arms to be remapped

Example: 9872E220DD074DD3B463143DAAA684DC:,9872E220DD074DD3B463143DAAA684DC:
type: string

Visit Design randomization type

Example: Blinded
visits: array visits

{
    "title":"VisitDesignRandomizationDto v2.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit Design randomization unique GUID",
            "format":"uuid"
        },
        "type":{
            "type":"string",
            "description":"Visit Design randomization type",
            "example":"Blinded"
        },
        "algorithm":{
            "type":"string",
            "description":"Visit Design allow randomization algorithm type",
            "example":"Central"
        },
        "treatmentArms":{
            "type":"string",
            "description":"Visit Design allow randomization treatment arms to be remapped",
            "example":"9872E220DD074DD3B463143DAAA684DC:,9872E220DD074DD3B463143DAAA684DC:"
        },
        "visits":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Visit Design randomization visit GUID's",
                "format":"uuid"
            }
        }
    },
    "description":"Visit design randomization."
}

Nested Schema : VisitDesignSchedulingDto v2.0

Type: object

Title: VisitDesignSchedulingDto v2.0

Visit design scheduling.

Show Source

afterDelayWindow: object Delay v2.0

Title: Delay v2.0

Schedule delay in days/hours.
delay: object Delay v2.0

Title: Delay v2.0

Schedule delay in days/hours.
fromVisitId: string (uuid)

Visit Design : scheduled from visit GUID

{
    "title":"VisitDesignSchedulingDto v2.0",
    "type":"object",
    "properties":{
        "fromVisitId":{
            "type":"string",
            "description":"Visit Design : scheduled from visit GUID",
            "format":"uuid"
        },
        "delay":{
            "$ref":"#/components/schemas/DelayV2"
        },
        "afterDelayWindow":{
            "$ref":"#/components/schemas/DelayV2"
        }
    },
    "description":"Visit design scheduling."
}

Nested Schema : VisitDesignStateDto v2.0

Type: object

Title: VisitDesignStateDto v2.0

Visit design state.

Show Source

dynamic: boolean

Yes - if Visit Design dynamic state.

Example: false
lastRequired: boolean

Yes - if Visit Design is last required state.

Example: false
repeating: boolean

Yes - if Visit Design is repeating state.

Example: false
required: boolean

Yes - if Visit Design is required state.

Example: true

{
    "title":"VisitDesignStateDto v2.0",
    "type":"object",
    "properties":{
        "dynamic":{
            "type":"boolean",
            "description":"Yes - if Visit Design dynamic state.",
            "example":false
        },
        "repeating":{
            "type":"boolean",
            "description":"Yes - if Visit Design is repeating state.",
            "example":false
        },
        "required":{
            "type":"boolean",
            "description":"Yes - if Visit Design is required state.",
            "example":true
        },
        "lastRequired":{
            "type":"boolean",
            "description":"Yes - if Visit Design is last required state.",
            "example":false
        }
    },
    "description":"Visit design state."
}

Nested Schema : visits

Type: array

Show Source

Array of: string(uuid)

Visit Design randomization visit GUID's

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Visit Design randomization visit GUID's",
        "format":"uuid"
    }
}

Nested Schema : Delay v2.0

Type: object

Title: Delay v2.0

Schedule delay in days/hours.

Show Source

days: integer (int32)
hours: integer (int32)

{
    "title":"Delay v2.0",
    "type":"object",
    "properties":{
        "days":{
            "type":"integer",
            "format":"int32"
        },
        "hours":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Schedule delay in days/hours."
}

204 Response

Successful operation.

Root Schema : schema

Type: array

Show Source

Array of: object VisitDesignDto v2.0

Title: VisitDesignDto v2.0

Visit Design Information

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

Nested Schema : VisitDesignDto v2.0

Type: object

Title: VisitDesignDto v2.0

Visit Design Information

Show Source

dispensings: object VisitDesignDispensingDto v2.0

Title: VisitDesignDispensingDto v2.0

Visit design dispensings.
eventType: string

Visit Design event type

Example: ScreeningVisit
forms: object VisitDesignAssignedFormsDto v2.0

Title: VisitDesignAssignedFormsDto v2.0

Visit design assigned forms.
id: string (uuid)

Visit Design unique GUID
randomization: object VisitDesignRandomizationDto v2.0

Title: VisitDesignRandomizationDto v2.0

Visit design randomization.
scheduling: object VisitDesignSchedulingDto v2.0

Title: VisitDesignSchedulingDto v2.0

Visit design scheduling.
shortName: string

Visit Design short name

Example: Week1
state: object VisitDesignStateDto v2.0

Title: VisitDesignStateDto v2.0

Visit design state.
title: string

Visit design title

Example: Week1

{
    "title":"VisitDesignDto v2.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit Design unique GUID",
            "format":"uuid"
        },
        "title":{
            "type":"string",
            "description":"Visit design title",
            "example":"Week1"
        },
        "eventType":{
            "type":"string",
            "description":"Visit Design event type",
            "example":"ScreeningVisit"
        },
        "shortName":{
            "type":"string",
            "description":"Visit Design short name",
            "example":"Week1"
        },
        "state":{
            "$ref":"#/components/schemas/VisitDesignStateDtoV2"
        },
        "scheduling":{
            "$ref":"#/components/schemas/VisitDesignSchedulingDtoV2"
        },
        "randomization":{
            "$ref":"#/components/schemas/VisitDesignRandomizationDtoV2"
        },
        "forms":{
            "$ref":"#/components/schemas/VisitDesignAssignedFormsDtoV2"
        },
        "dispensings":{
            "$ref":"#/components/schemas/VisitDesignDispensingDtoV2"
        }
    },
    "description":"Visit Design Information"
}

Nested Schema : VisitDesignDispensingDto v2.0

Type: object

Title: VisitDesignDispensingDto v2.0

Visit design dispensings.

Show Source

count: integer (int32)

Visit Design dispensing count

Example: 1
titrationCount: integer (int32)

Visit Design titration count

Example: 1

{
    "title":"VisitDesignDispensingDto v2.0",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"Visit Design dispensing count",
            "format":"int32",
            "example":1
        },
        "titrationCount":{
            "type":"integer",
            "description":"Visit Design titration count",
            "format":"int32",
            "example":1
        }
    },
    "description":"Visit design dispensings."
}

Nested Schema : VisitDesignAssignedFormsDto v2.0

Type: object

Title: VisitDesignAssignedFormsDto v2.0

Visit design assigned forms.

Show Source

count: integer (int32)

Count of the forms assigned to the visit

Example: 1

{
    "title":"VisitDesignAssignedFormsDto v2.0",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"Count of the forms assigned to the visit",
            "format":"int32",
            "example":1
        }
    },
    "description":"Visit design assigned forms."
}

Nested Schema : VisitDesignRandomizationDto v2.0

Type: object

Title: VisitDesignRandomizationDto v2.0

Visit design randomization.

Show Source

algorithm: string

Visit Design allow randomization algorithm type

Example: Central
id: string (uuid)

Visit Design randomization unique GUID
treatmentArms: string

Visit Design allow randomization treatment arms to be remapped

Example: 9872E220DD074DD3B463143DAAA684DC:,9872E220DD074DD3B463143DAAA684DC:
type: string

Visit Design randomization type

Example: Blinded
visits: array visits

{
    "title":"VisitDesignRandomizationDto v2.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit Design randomization unique GUID",
            "format":"uuid"
        },
        "type":{
            "type":"string",
            "description":"Visit Design randomization type",
            "example":"Blinded"
        },
        "algorithm":{
            "type":"string",
            "description":"Visit Design allow randomization algorithm type",
            "example":"Central"
        },
        "treatmentArms":{
            "type":"string",
            "description":"Visit Design allow randomization treatment arms to be remapped",
            "example":"9872E220DD074DD3B463143DAAA684DC:,9872E220DD074DD3B463143DAAA684DC:"
        },
        "visits":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Visit Design randomization visit GUID's",
                "format":"uuid"
            }
        }
    },
    "description":"Visit design randomization."
}

Nested Schema : VisitDesignSchedulingDto v2.0

Type: object

Title: VisitDesignSchedulingDto v2.0

Visit design scheduling.

Show Source

afterDelayWindow: object Delay v2.0

Title: Delay v2.0

Schedule delay in days/hours.
delay: object Delay v2.0

Title: Delay v2.0

Schedule delay in days/hours.
fromVisitId: string (uuid)

Visit Design : scheduled from visit GUID

{
    "title":"VisitDesignSchedulingDto v2.0",
    "type":"object",
    "properties":{
        "fromVisitId":{
            "type":"string",
            "description":"Visit Design : scheduled from visit GUID",
            "format":"uuid"
        },
        "delay":{
            "$ref":"#/components/schemas/DelayV2"
        },
        "afterDelayWindow":{
            "$ref":"#/components/schemas/DelayV2"
        }
    },
    "description":"Visit design scheduling."
}

Nested Schema : VisitDesignStateDto v2.0

Type: object

Title: VisitDesignStateDto v2.0

Visit design state.

Show Source

dynamic: boolean

Yes - if Visit Design dynamic state.

Example: false
lastRequired: boolean

Yes - if Visit Design is last required state.

Example: false
repeating: boolean

Yes - if Visit Design is repeating state.

Example: false
required: boolean

Yes - if Visit Design is required state.

Example: true

{
    "title":"VisitDesignStateDto v2.0",
    "type":"object",
    "properties":{
        "dynamic":{
            "type":"boolean",
            "description":"Yes - if Visit Design dynamic state.",
            "example":false
        },
        "repeating":{
            "type":"boolean",
            "description":"Yes - if Visit Design is repeating state.",
            "example":false
        },
        "required":{
            "type":"boolean",
            "description":"Yes - if Visit Design is required state.",
            "example":true
        },
        "lastRequired":{
            "type":"boolean",
            "description":"Yes - if Visit Design is last required state.",
            "example":false
        }
    },
    "description":"Visit design state."
}

Nested Schema : visits

Type: array

Show Source

Array of: string(uuid)

Visit Design randomization visit GUID's

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Visit Design randomization visit GUID's",
        "format":"uuid"
    }
}

Nested Schema : Delay v2.0

Type: object

Title: Delay v2.0

Schedule delay in days/hours.

Show Source

days: integer (int32)
hours: integer (int32)

{
    "title":"Delay v2.0",
    "type":"object",
    "properties":{
        "days":{
            "type":"integer",
            "format":"int32"
        },
        "hours":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Schedule delay in days/hours."
}

500 Response

Error

Root Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}