Jump to

• Request
• Response

Get list of dispensation visits in a study version

get

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

Retrieves list of all dispensation visits in a study version.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID. Example: F054C951EB74443C93716CA714AB686E
• version(required): string
  Study version. Example: "1.0.0.1"

Query Parameters

• kitType: string
  Default Value: 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 v4.0
  Title: RespArmKitVisitDto v4.0

  Error parameters list.

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

Nested Schema : RespArmKitVisitDto v4.0

Type: object

Title: RespArmKitVisitDto v4.0

Error parameters list.

Show Source

• allowTitration: boolean
  Indicates if titration is allowed on the kit.

  Example: false
• armid: string (uuid)
  Treatment Arm GUID
• 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
• dosingId: string (uuid)
  Dosing GUID
• errorParamList: array errorParamList
• id: string (uuid)
  Dispensation GUID
• kitid: string (uuid)
  Kit GUID
• quantity: integer (int64)
  Kit quantity or dose.

  Example: 1
• titrationKits: array titrationKits
• visitid: string (uuid)
  Visit GUID

{
    "title":"RespArmKitVisitDto v4.0",
    "type":"object",
    "properties":{
        "kitid":{
            "type":"string",
            "description":"Kit GUID",
            "format":"uuid"
        },
        "armid":{
            "type":"string",
            "description":"Treatment Arm GUID",
            "format":"uuid"
        },
        "visitid":{
            "type":"string",
            "description":"Visit GUID",
            "format":"uuid"
        },
        "dosingId":{
            "type":"string",
            "description":"Dosing GUID",
            "format":"uuid"
        },
        "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
        },
        "id":{
            "type":"string",
            "description":"Dispensation GUID",
            "format":"uuid"
        },
        "allowTitration":{
            "type":"boolean",
            "description":"Indicates if titration is allowed on the kit.",
            "example":false
        },
        "titrationKits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ArmKitVisitTitrationDtoV6"
            }
        },
        "errorParamList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RespErrParamListDtoV1"
            }
        }
    },
    "description":"Error parameters list."
}

Nested Schema : errorParamList

Type: array

Show Source

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

  Error parameters list.

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

Nested Schema : titrationKits

Type: array

Show Source

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

  Kit dispensations for a titration group.

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

Nested Schema : RespErrParamListDto v1.0

Type: object

Title: RespErrParamListDto v1.0

Error parameters list.

Show Source

• ErrorParam: array ErrorParam

{
    "title":"RespErrParamListDto v1.0",
    "type":"object",
    "properties":{
        "ErrorParam":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorParam"
            }
        }
    },
    "description":"Error parameters list."
}

Nested Schema : ErrorParam

Type: array

Show Source

• Array of: object ErrorParam
  Title: ErrorParam

  Error parameter

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

Nested Schema : ErrorParam

Type: object

Title: ErrorParam

Error parameter

Show Source

• id: string (uuid)
  Missing object unique GUID
• key: string (uuid)
  Kit unique GUID
• name: string
  Name

  Example: WEEK5
• type: string
  Missing object type

  Example: Visit

{
    "title":"ErrorParam",
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"Kit unique GUID",
            "format":"uuid"
        },
        "type":{
            "type":"string",
            "description":"Missing object type",
            "example":"Visit"
        },
        "id":{
            "type":"string",
            "description":"Missing object unique GUID",
            "format":"uuid"
        },
        "name":{
            "type":"string",
            "description":"Name",
            "example":"WEEK5"
        }
    },
    "description":"Error parameter"
}

Nested Schema : ArmKitVisitTitrationDto v3.0

Type: object

Title: ArmKitVisitTitrationDto v3.0

Kit dispensations for a titration group.

Show Source

• kitid: string (uuid)
  Kit GUID
• kitQuantity: integer (int64)
  Visit Quantity

  Example: 1
• kitTypeId: string
  Kit Type Id

  Example: Kit A 20mg

{
    "title":"ArmKitVisitTitrationDto v3.0",
    "type":"object",
    "properties":{
        "kitTypeId":{
            "type":"string",
            "description":"Kit Type Id",
            "example":"Kit A 20mg"
        },
        "kitid":{
            "type":"string",
            "description":"Kit GUID",
            "format":"uuid"
        },
        "kitQuantity":{
            "type":"integer",
            "description":"Visit Quantity",
            "format":"int64",
            "example":"1"
        }
    },
    "description":"Kit dispensations for a titration group."
}

500 Response

Error

Body ()

Root Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : details

Type: object

Back to Top