Jump to

• Request
• Response

V1.0

get

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

Retrieves arm dispensing assignments. Use the latest supported arm endpoint in v17.0 for current behavior.

Request

Path Parameters

• armId(required): string
  Arm ID (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

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 ArmKitVisitDto v1.0
  Title: ArmKitVisitDto v1.0

  Visit kit dispensation per treatment arm.

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

Nested Schema : ArmKitVisitDto v1.0

Type: object

Title: ArmKitVisitDto v1.0

Visit kit dispensation per treatment arm.

Show Source

• armid: string (uuid)
  Treatment Arm GUID
• armVersionStart: string (date-time)
  Arm Version Start
• dispenseoutsidewindow: boolean
  Kit can be dispensed outside the schedule window.

  Example: false
• dnd: integer (int64)
  Do not Dispense - a number of days before kit expiration date when kit cannot be dispensed.

  Example: 5
• id: string (uuid)
  Surrogate GUID based on Arm, Kit, and Visit GUIDs
• kitid: string (uuid)
  Kit GUID
• kitVersionStart: string (date-time)
  Kit Version Start
• quantity: integer (int64)
  Kit quantity or dose.

  Example: 1
• versionStart: string (date-time)
  Version Start
• visitid: string (uuid)
  Visit GUID
• visitVersionStart: string (date-time)
  Visit Version Start

{
    "title":"ArmKitVisitDto v1.0",
    "type":"object",
    "properties":{
        "armid":{
            "type":"string",
            "description":"Treatment Arm GUID",
            "format":"uuid"
        },
        "armVersionStart":{
            "type":"string",
            "description":"Arm Version Start",
            "format":"date-time"
        },
        "kitid":{
            "type":"string",
            "description":"Kit GUID",
            "format":"uuid"
        },
        "kitVersionStart":{
            "type":"string",
            "description":"Kit Version Start",
            "format":"date-time"
        },
        "visitid":{
            "type":"string",
            "description":"Visit GUID",
            "format":"uuid"
        },
        "visitVersionStart":{
            "type":"string",
            "description":"Visit Version Start",
            "format":"date-time"
        },
        "quantity":{
            "type":"integer",
            "description":"Kit quantity or dose.",
            "format":"int64",
            "example":1
        },
        "dnd":{
            "type":"integer",
            "description":"Do not Dispense - a number of days before kit expiration date when kit cannot be dispensed.",
            "format":"int64",
            "example":5
        },
        "dispenseoutsidewindow":{
            "type":"boolean",
            "description":"Kit can be dispensed outside the schedule window.",
            "example":false
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "id":{
            "type":"string",
            "description":"Surrogate GUID based on Arm, Kit, and Visit GUIDs",
            "format":"uuid"
        }
    },
    "description":"Visit kit dispensation per treatment arm."
}

Examples

Select an example listArmDispensingsV1Response

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