1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Designer
  4. Kits APIs
  5. Get the dispensation data of a kit

[Deprecated]: V4.0
get

/ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/kits/{kitId}/dispensings

Deprecated: Use latest version instead. Retrieves dispensation information for a kit in a study.

Request

Path Parameters
Query Parameters
  • Kit type filter. Optional. Accepted values include STANDARD, TITRATION, ALL, and DEVICE.
    Example:
    STANDARD

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : RespArmKitVisitDto v4.0
Type: object
Title: RespArmKitVisitDto v4.0
Dispensing assignment returned for a treatment arm in a study version.
Show Source
  • Indicates whether titration is allowed for this dispensing assignment. Optional.
    Example: false
  • Treatment arm ID (UUID, 32-character uppercase hexadecimal string). Required when the visit uses treatment-arm specific dispensing; otherwise optional.
    Example: B1B8327AFAA6412287106192AB5984EF
  • 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
  • Dosing ID associated with the dispensing assignment (UUID, 32-character uppercase hexadecimal string). Required only for kits that calculate doses; omit for titration groups.
    Example: F5F8327AFAA6412287106192AB5984EF
  • errorParamList
  • Dispensing assignment ID (UUID, 32-character uppercase hexadecimal string).
    Example: E4E8327AFAA6412287106192AB5984EF
  • Kit or titration group ID (UUID, 32-character uppercase hexadecimal string). Required.
    Example: C2C8327AFAA6412287106192AB5984EF
  • Number of kits or dose quantity to dispense at the visit. Required for standard kit create/update; use -1 to remove an existing assignment. Omit for titration group assignments.
    Example: 1
  • titrationKits
  • Visit ID (UUID, 32-character uppercase hexadecimal string). Required.
    Example: D3D8327AFAA6412287106192AB5984EF
Example:
{
    "kitid":"C2C8327AFAA6412287106192AB5984EF",
    "armid":"B1B8327AFAA6412287106192AB5984EF",
    "visitid":"D3D8327AFAA6412287106192AB5984EF",
    "dosingId":"F5F8327AFAA6412287106192AB5984EF",
    "quantity":1,
    "dnd":5,
    "dispenseoutsidewindow":true,
    "allowTitration":false,
    "id":"E4E8327AFAA6412287106192AB5984EF"
}
Nested Schema : errorParamList
Type: array
Show Source
Nested Schema : titrationKits
Type: array
Show Source
Nested Schema : RespErrParamListDto v1.0
Type: object
Title: RespErrParamListDto v1.0
Validation error parameters returned with an API response.
Show Source
Example:
{
    "errorParamList":[
        {
            "key":"C2C8327AFAA6412287106192AB5984EF",
            "type":"Visit",
            "id":"D3D8327AFAA6412287106192AB5984EF",
            "name":"Week 5"
        }
    ]
}
Nested Schema : ErrorParam
Type: array
Show Source
Nested Schema : ErrorParam
Type: object
Title: ErrorParam
Validation parameter that identifies an object related to an API validation error.
Show Source
  • Related object ID (UUID, 32-character uppercase hexadecimal string).
  • Related object key (UUID, 32-character uppercase hexadecimal string).
  • Display name of the object related to the validation error.
    Example: Week 5
  • Type of object related to the validation error.
    Example: Visit
Example:
{
    "key":"C2C8327AFAA6412287106192AB5984EF",
    "type":"Visit",
    "id":"D3D8327AFAA6412287106192AB5984EF",
    "name":"Week 5"
}
Nested Schema : ArmKitVisitTitrationDto v4.0
Type: object
Title: ArmKitVisitTitrationDto v4.0
Kit included in a titration dispensing group.
Show Source
  • Kit ID (UUID, 32-character uppercase hexadecimal string). Required for each titration kit entry.
    Example: C2C8327AFAA6412287106192AB5984EF
  • Number of kits from this kit type to dispense. Required for each titration kit entry.
    Example: 1
  • Kit type identifier shown for the titration kit. Optional.
    Example: KIT_A_20MG
Example:
{
    "kitId":"C2C8327AFAA6412287106192AB5984EF",
    "kitTypeId":"KIT_A_20MG",
    "kitQuantity":1
}
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