Jump to

• Request
• Response

[Deprecated]: V1.0

get

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

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

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

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

Nested Schema : RespArmKitVisitDto v1.0

Type: object

Title: RespArmKitVisitDto v1.0

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

Show Source

• armid: string
  Treatment arm ID (UUID, 32-character uppercase hexadecimal string). Required when the visit uses treatment-arm specific dispensing; otherwise optional.

  Example: B1B8327AFAA6412287106192AB5984EF
• armVersionStart: string (date-time)
  Date and time when the treatment arm version starts.

  Example: 2024-01-15T10:30:00Z
• dispenseoutsidewindow: boolean
  Indicates whether the kit can be dispensed outside the visit schedule window. Required for create/update.

  Example: true
• dnd: integer (int64)
  Number of days before kit expiration when the kit can no longer be dispensed. Required for create/update; valid range is 0 to 9999.

  Example: 5
• id: string
  Dispensing assignment ID generated from the treatment arm, kit, and visit IDs (UUID, 32-character uppercase hexadecimal string).

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

  Example: C2C8327AFAA6412287106192AB5984EF
• kitVersionStart: string (date-time)
  Date and time when the kit version starts.

  Example: 2024-01-15T10:30:00Z
• quantity: integer (int64)
  Number of kits or dose quantity to dispense at the visit. Required for create/update; use -1 to remove an existing assignment.

  Example: 1
• versionStart: string (date-time)
  Version Start date

  Example: 2018-11-23T08:43:01.7Z
• visitid: string
  Visit ID (UUID, 32-character uppercase hexadecimal string). Required.

  Example: D3D8327AFAA6412287106192AB5984EF
• visitVersionStart: string (date-time)
  Date and time when the visit version starts.

  Example: 2024-01-15T10:30:00Z

{
    "title":"RespArmKitVisitDto v1.0",
    "type":"object",
    "properties":{
        "armid":{
            "type":"string",
            "description":"Treatment arm ID (UUID, 32-character uppercase hexadecimal string). Required when the visit uses treatment-arm specific dispensing; otherwise optional.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "armVersionStart":{
            "type":"string",
            "description":"Date and time when the treatment arm version starts.",
            "format":"date-time",
            "example":"2024-01-15T10:30:00Z"
        },
        "kitid":{
            "type":"string",
            "description":"Kit ID (UUID, 32-character uppercase hexadecimal string). Required.",
            "example":"C2C8327AFAA6412287106192AB5984EF"
        },
        "kitVersionStart":{
            "type":"string",
            "description":"Date and time when the kit version starts.",
            "format":"date-time",
            "example":"2024-01-15T10:30:00Z"
        },
        "visitid":{
            "type":"string",
            "description":"Visit ID (UUID, 32-character uppercase hexadecimal string). Required.",
            "example":"D3D8327AFAA6412287106192AB5984EF"
        },
        "visitVersionStart":{
            "type":"string",
            "description":"Date and time when the visit version starts.",
            "format":"date-time",
            "example":"2024-01-15T10:30:00Z"
        },
        "quantity":{
            "type":"integer",
            "description":"Number of kits or dose quantity to dispense at the visit. Required for create/update; use -1 to remove an existing assignment.",
            "format":"int64",
            "example":1
        },
        "dnd":{
            "type":"integer",
            "description":"Number of days before kit expiration when the kit can no longer be dispensed. Required for create/update; valid range is 0 to 9999.",
            "format":"int64",
            "example":5
        },
        "dispenseoutsidewindow":{
            "type":"boolean",
            "description":"Indicates whether the kit can be dispensed outside the visit schedule window. Required for create/update.",
            "example":true
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start date",
            "format":"date-time",
            "example":"2018-11-23T08:43:01.7Z"
        },
        "id":{
            "type":"string",
            "description":"Dispensing assignment ID generated from the treatment arm, kit, and visit IDs (UUID, 32-character uppercase hexadecimal string).",
            "example":"E4E8327AFAA6412287106192AB5984EF"
        }
    },
    "description":"Dispensing assignment returned for a treatment arm in a study version.",
    "example":{
        "armid":"B1B8327AFAA6412287106192AB5984EF",
        "armVersionStart":"2024-01-15T10:30:00Z",
        "kitid":"C2C8327AFAA6412287106192AB5984EF",
        "kitVersionStart":"2024-01-15T10:30:00Z",
        "visitid":"D3D8327AFAA6412287106192AB5984EF",
        "visitVersionStart":"2024-01-15T10:30:00Z",
        "quantity":1,
        "dnd":5,
        "dispenseoutsidewindow":true,
        "versionStart":"2024-01-15T10:30:00Z",
        "id":"E4E8327AFAA6412287106192AB5984EF"
    }
}

Example:

{
    "armid":"B1B8327AFAA6412287106192AB5984EF",
    "armVersionStart":"2024-01-15T10:30:00Z",
    "kitid":"C2C8327AFAA6412287106192AB5984EF",
    "kitVersionStart":"2024-01-15T10:30:00Z",
    "visitid":"D3D8327AFAA6412287106192AB5984EF",
    "visitVersionStart":"2024-01-15T10:30:00Z",
    "quantity":1,
    "dnd":5,
    "dispenseoutsidewindow":true,
    "versionStart":"2024-01-15T10:30:00Z",
    "id":"E4E8327AFAA6412287106192AB5984EF"
}

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