1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Designer
  4. Visit APIs
  5. Dispensation Visits
  6. Update list of dispensation visits

[Deprecated]: V1.0
put

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

Deprecated: Use latest version instead. Updates dispensing visit assignments for the specified study version. Submit the dispensing rows to save, including kit, visit, optional treatment arm, quantity, do-not-dispense days, titration details, and outside-window settings. The response returns the updated dispensing rows and any row-level reference details produced during validation.

Request

Path Parameters
Query Parameters
  • Visit ID where randomization was assigned (UUID, 32-character uppercase hexadecimal string). Optional.
    Default Value: empty
    Example:
    9F4A6C7E1B8F4D56A23C9F3A0C7D4E77
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: array
Show Source
Nested Schema : ArmKitVisitDto v1.0
Type: object
Title: ArmKitVisitDto v1.0
Dispensing assignment that connects a treatment arm, kit, and visit in a study version.
Show Source
  • Treatment arm ID (UUID, 32-character uppercase hexadecimal string). Required when the visit uses treatment-arm specific dispensing; otherwise optional.
    Example: B1B8327AFAA6412287106192AB5984EF
  • Date and time when the treatment arm version starts.
    Example: 2024-01-15T10:30:00Z
  • Indicates whether the kit can be dispensed outside the visit schedule window. Required for create/update.
    Example: true
  • 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
  • Dispensing assignment ID generated from the treatment arm, kit, and visit IDs (UUID, 32-character uppercase hexadecimal string).
    Example: E4E8327AFAA6412287106192AB5984EF
  • Kit ID (UUID, 32-character uppercase hexadecimal string). Required.
    Example: C2C8327AFAA6412287106192AB5984EF
  • Date and time when the kit version starts.
    Example: 2024-01-15T10:30:00Z
  • Number of kits or dose quantity to dispense at the visit. Required for create/update; use -1 to remove an existing assignment.
    Example: 1
  • Version Start date
    Example: 2018-11-23T08:43:01.7Z
  • Visit ID (UUID, 32-character uppercase hexadecimal string). Required.
    Example: D3D8327AFAA6412287106192AB5984EF
  • Date and time when the visit version starts.
    Example: 2024-01-15T10:30:00Z
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

Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : RespArmKitVisitDto v1.0
Type: object
Title: RespArmKitVisitDto v1.0
Dispensing assignment returned for a treatment arm in a study version.
Show Source
  • Treatment arm ID (UUID, 32-character uppercase hexadecimal string). Required when the visit uses treatment-arm specific dispensing; otherwise optional.
    Example: B1B8327AFAA6412287106192AB5984EF
  • Date and time when the treatment arm version starts.
    Example: 2024-01-15T10:30:00Z
  • Indicates whether the kit can be dispensed outside the visit schedule window. Required for create/update.
    Example: true
  • 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
  • Dispensing assignment ID generated from the treatment arm, kit, and visit IDs (UUID, 32-character uppercase hexadecimal string).
    Example: E4E8327AFAA6412287106192AB5984EF
  • Kit ID (UUID, 32-character uppercase hexadecimal string). Required.
    Example: C2C8327AFAA6412287106192AB5984EF
  • Date and time when the kit version starts.
    Example: 2024-01-15T10:30:00Z
  • Number of kits or dose quantity to dispense at the visit. Required for create/update; use -1 to remove an existing assignment.
    Example: 1
  • Version Start date
    Example: 2018-11-23T08:43:01.7Z
  • Visit ID (UUID, 32-character uppercase hexadecimal string). Required.
    Example: D3D8327AFAA6412287106192AB5984EF
  • Date and time when the visit version starts.
    Example: 2024-01-15T10:30:00Z
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

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
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • 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
Nested Schema : Object
Type: object
Title: Object
Object with error details information.
Example:
{
    "field":"studyId",
    "reason":"Invalid value"
}
Back to Top