Jump to

• Request
• Response

V7.0

get

/ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/arms/{armId}/dispensings

Retrieves dispensing assignments for a treatment arm in a study version. Each item identifies the kit and visit and includes dispensing settings such as quantity, do-not-dispense days, and whether dispensing outside the visit window is allowed.

Request

Path Parameters

• armId(required): string
  Treatment arm identifier (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  B1B8327AFAA6412287106192AB5984EF

• studyId(required): string(uuid)
  Study ID (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  F054C951EB74443C93716CA714AB686E

• version(required): string
  Study version path segment. Required. Example: "1.0.0.1".

  Example:

  1.0.0.1

Query Parameters

• kitType: string
  Type of kits requested. Optional. Allowed values: ALL, STANDARD, TITRATION, DEVICE.

  Default Value: ALL

  Example:

  ALL

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object RespArmKitVisitDto v7.0
  Title: RespArmKitVisitDto v7.0

  Dispensing assignment returned for a treatment arm in a study version.

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

Nested Schema : RespArmKitVisitDto v7.0

Type: object

Title: RespArmKitVisitDto v7.0

Dispensing assignment returned for a treatment arm in a study version.

Show Source

• allowTitration: boolean
  Indicates whether titration is allowed for this dispensing assignment.

  Example: false
• armid: string
  Treatment arm ID (UUID, 32-character uppercase hexadecimal string).

  Example: B1B8327AFAA6412287106192AB5984EF
• dispenseoutsidewindow: boolean
  Indicates whether the kit can be dispensed outside the visit schedule window.

  Example: true
• dnd: integer (int64)
  Number of days before kit expiration when the kit can no longer be dispensed.

  Example: 5
• dosingId: string
  Dosing ID associated with the dispensing assignment (UUID, 32-character uppercase hexadecimal string).

  Example: F5F8327AFAA6412287106192AB5984EF
• errorParamList: array errorParamList
• id: string
  Dispensing assignment ID (UUID, 32-character uppercase hexadecimal string).

  Example: E4E8327AFAA6412287106192AB5984EF
• kitid: string
  Kit or titration group ID (UUID, 32-character uppercase hexadecimal string).

  Example: C2C8327AFAA6412287106192AB5984EF
• quantity: integer (int64)
  Number of kits or dose quantity to dispense at the visit.

  Example: 1
• titrationKits: array titrationKits
• visitid: string
  Visit ID (UUID, 32-character uppercase hexadecimal string).

  Example: D3D8327AFAA6412287106192AB5984EF

{
    "title":"RespArmKitVisitDto v7.0",
    "type":"object",
    "properties":{
        "kitid":{
            "type":"string",
            "description":"Kit or titration group ID (UUID, 32-character uppercase hexadecimal string).",
            "example":"C2C8327AFAA6412287106192AB5984EF"
        },
        "armid":{
            "type":"string",
            "description":"Treatment arm ID (UUID, 32-character uppercase hexadecimal string).",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "visitid":{
            "type":"string",
            "description":"Visit ID (UUID, 32-character uppercase hexadecimal string).",
            "example":"D3D8327AFAA6412287106192AB5984EF"
        },
        "dosingId":{
            "type":"string",
            "description":"Dosing ID associated with the dispensing assignment (UUID, 32-character uppercase hexadecimal string).",
            "example":"F5F8327AFAA6412287106192AB5984EF"
        },
        "quantity":{
            "type":"integer",
            "description":"Number of kits or dose quantity to dispense at the visit.",
            "format":"int64",
            "example":1
        },
        "dnd":{
            "type":"integer",
            "description":"Number of days before kit expiration when the kit can no longer be dispensed.",
            "format":"int64",
            "example":5
        },
        "dispenseoutsidewindow":{
            "type":"boolean",
            "description":"Indicates whether the kit can be dispensed outside the visit schedule window.",
            "example":true
        },
        "id":{
            "type":"string",
            "description":"Dispensing assignment ID (UUID, 32-character uppercase hexadecimal string).",
            "example":"E4E8327AFAA6412287106192AB5984EF"
        },
        "allowTitration":{
            "type":"boolean",
            "description":"Indicates whether titration is allowed for this dispensing assignment.",
            "example":false
        },
        "titrationKits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ArmKitVisitTitrationDtoV7"
            }
        },
        "errorParamList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RespErrParamListDtoV1"
            }
        }
    },
    "description":"Dispensing assignment returned for a treatment arm in a study version."
}

Nested Schema : errorParamList

Type: array

Show Source

• Array of: object RespErrParamListDto v1.0
  Title: RespErrParamListDto v1.0

  Validation error parameters returned with an API response.

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

Nested Schema : titrationKits

Type: array

Show Source

• Array of: object ArmKitVisitTitrationDto v7.0
  Title: ArmKitVisitTitrationDto v7.0

  Kit included in a titration dispensing group.

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

Nested Schema : RespErrParamListDto v1.0

Type: object

Title: RespErrParamListDto v1.0

Validation error parameters returned with an API response.

Show Source

• ErrorParam: array ErrorParam

{
    "title":"RespErrParamListDto v1.0",
    "type":"object",
    "properties":{
        "ErrorParam":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorParam"
            }
        }
    },
    "description":"Validation error parameters returned with an API response.",
    "example":{
        "errorParamList":[
            {
                "key":"C2C8327AFAA6412287106192AB5984EF",
                "type":"Visit",
                "id":"D3D8327AFAA6412287106192AB5984EF",
                "name":"Week 5"
            }
        ]
    }
}

Example:

{
    "errorParamList":[
        {
            "key":"C2C8327AFAA6412287106192AB5984EF",
            "type":"Visit",
            "id":"D3D8327AFAA6412287106192AB5984EF",
            "name":"Week 5"
        }
    ]
}

Nested Schema : ErrorParam

Type: array

Show Source

• Array of: object ErrorParam
  Title: ErrorParam

  Validation parameter that identifies an object related to an API validation error.

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

Nested Schema : ErrorParam

Type: object

Title: ErrorParam

Validation parameter that identifies an object related to an API validation error.

Show Source

• id: string (uuid)
  Related object ID (UUID, 32-character uppercase hexadecimal string).
• key: string (uuid)
  Related object key (UUID, 32-character uppercase hexadecimal string).
• name: string
  Display name of the object related to the validation error.

  Example: Week 5
• type: string
  Type of object related to the validation error.

  Example: Visit

{
    "title":"ErrorParam",
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"Related object key (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "type":{
            "type":"string",
            "description":"Type of object related to the validation error.",
            "example":"Visit"
        },
        "id":{
            "type":"string",
            "description":"Related object ID (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "name":{
            "type":"string",
            "description":"Display name of the object related to the validation error.",
            "example":"Week 5"
        }
    },
    "description":"Validation parameter that identifies an object related to an API validation error.",
    "example":{
        "key":"C2C8327AFAA6412287106192AB5984EF",
        "type":"Visit",
        "id":"D3D8327AFAA6412287106192AB5984EF",
        "name":"Week 5"
    }
}

Example:

{
    "key":"C2C8327AFAA6412287106192AB5984EF",
    "type":"Visit",
    "id":"D3D8327AFAA6412287106192AB5984EF",
    "name":"Week 5"
}

Nested Schema : ArmKitVisitTitrationDto v7.0

Type: object

Title: ArmKitVisitTitrationDto v7.0

Kit included in a titration dispensing group.

Show Source

• kitId: string
  Kit ID (UUID, 32-character uppercase hexadecimal string).

  Example: C2C8327AFAA6412287106192AB5984EF
• kitQuantity: integer (int64)
  Number of kits from this kit type to dispense.

  Example: 1
• kitTypeId: string
  Kit type identifier shown for the titration kit.

  Example: KIT_A_20MG

{
    "title":"ArmKitVisitTitrationDto v7.0",
    "type":"object",
    "properties":{
        "kitTypeId":{
            "type":"string",
            "description":"Kit type identifier shown for the titration kit.",
            "example":"KIT_A_20MG"
        },
        "kitId":{
            "type":"string",
            "description":"Kit ID (UUID, 32-character uppercase hexadecimal string).",
            "example":"C2C8327AFAA6412287106192AB5984EF"
        },
        "kitQuantity":{
            "type":"integer",
            "description":"Number of kits from this kit type to dispense.",
            "format":"int64",
            "example":1
        }
    },
    "description":"Kit included in a titration dispensing group."
}

Examples

Select an example successResponse

500 Response

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.

Body ()

Root Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Back to Top