REST API for Clinical One Platform

Get dispensation info for a subject

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/visits/{visitId}

Retrieves dispensation info of most recent dispensation happened or all previou dispensations for a study by subject and visit ID. Rights: OrsUnblinded

Request

Path Parameters

mode(required): string

Mode of the study, accepts: test, active, or training
studyId(required): string(uuid)

ID of the study
subjectId(required): string(uuid)

ID of the subject
visitId(required): string(uuid)

ID of the visit

Query Parameters

dispensationInfo(required): string

Dispensation info requried [last/previous]
includeReplacementVisits: string

Include replacement visits [Y/N]
includeUnScheduledVisits: string

Include unScheduled visits [Y/N]
instanceNumber: number

Instance number for unscheduled visit.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Type: array

Show Source

Array of: object DispensationInfoResponse

Title: DispensationInfoResponse

Response object containing dispensation information for a subject visit.

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

Nested Schema : DispensationInfoResponse

Type: object

Title: DispensationInfoResponse

Response object containing dispensation information for a subject visit.

Show Source

dateDispensed: string (date-time)

Date dispensed
dosage: number (double)

Dosage

Example: 0.5
eventInstanceNumber: number (double)

Event Instance Number

Example: 2
isHeld: boolean

Indicates if dose hold is ture or false

Example: false
kitDescription: string

Kit Description

Example: Kit A description paracetamol 5mg
kitType: string

Kit Type

Example: KitA
kitTypeSrcId: string (uuid)

Kit Type Source Id
quantity: number (double)

Quantity

Example: 3
visitName: string

Visit Name

Example: Week1
visitSrcId: string (uuid)

Visit Source Id

{
    "title":"DispensationInfoResponse",
    "type":"object",
    "properties":{
        "visitSrcId":{
            "type":"string",
            "description":"Visit Source Id",
            "format":"uuid"
        },
        "visitName":{
            "type":"string",
            "description":"Visit Name",
            "example":"Week1"
        },
        "eventInstanceNumber":{
            "type":"number",
            "description":"Event Instance Number",
            "format":"double",
            "example":2
        },
        "kitTypeSrcId":{
            "type":"string",
            "description":"Kit Type Source Id",
            "format":"uuid"
        },
        "kitType":{
            "type":"string",
            "description":"Kit Type",
            "example":"KitA"
        },
        "kitDescription":{
            "type":"string",
            "description":"Kit Description",
            "example":"Kit A description paracetamol 5mg"
        },
        "dateDispensed":{
            "type":"string",
            "description":"Date dispensed",
            "format":"date-time"
        },
        "dosage":{
            "type":"number",
            "description":"Dosage",
            "format":"double",
            "example":0.5
        },
        "quantity":{
            "type":"number",
            "description":"Quantity",
            "format":"double",
            "example":3
        },
        "isHeld":{
            "type":"boolean",
            "description":"Indicates if dose hold is ture or false",
            "example":false
        }
    },
    "description":"Response object containing dispensation information for a subject visit."
}

400 Response

Invalid parameters

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
result: object result

Result Object
status: string

Status of request

Example: Success
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

404 Response

Invalid study ID or visit ID OR Subject not found

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
result: object result

Result Object
status: string

Status of request

Example: Success
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

500 Response

Error

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
result: object result

Result Object
status: string

Status of request

Example: Success
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object