REST API for Clinical One Platform

Get unblinded dispensation history

get

/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/unblinded-disp-history

Retrieves history of unblinded dispensation for a subject within the study. Rights: OrsSubjectVisitGet.

Request

Path Parameters

mode(required): string

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

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

ID of the study

Query Parameters

visitId(required): string

ID of the visit

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : UnblindedDispensationHistoryDTO

Type: object

Title: UnblindedDispensationHistoryDTO

Contains unblinded dispensation history.

Show Source

kitTypes: array kitTypes

{
    "title":"UnblindedDispensationHistoryDTO",
    "type":"object",
    "properties":{
        "kitTypes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KitTypeDetailsDTO"
            }
        }
    },
    "description":"Contains unblinded dispensation history."
}

Nested Schema : kitTypes

Type: array

Show Source

Array of: object KitTypeDetailsDTO

Title: KitTypeDetailsDTO

Contains kit type details.

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

Nested Schema : KitTypeDetailsDTO

Type: object

Title: KitTypeDetailsDTO

Contains kit type details.

Show Source

description: string

Kit Type description

Example: Kit A
dispensationDetails: array dispensationDetails
id: string (uuid)

ID of the kit type.
kitTypeName: string

Kit Type name

Example: Kit A
packageType: string

Allowed Values: [ "BLISTERPACK", "BOTTLE", "DEVICE", "SYRINGE", "OINTMENT", "VIAL", "INHALER", "INFUSION", "BOX", "OTHER" ]

Package Type

Example: INHALER
packageTypeId: number (double)

Allowed Values: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]

Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).

Example: 2

{
    "title":"KitTypeDetailsDTO",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the kit type.",
            "format":"uuid"
        },
        "dispensationDetails":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KitDispensationDTO"
            }
        },
        "kitTypeName":{
            "type":"string",
            "description":"Kit Type name",
            "example":"Kit A"
        },
        "description":{
            "type":"string",
            "description":"Kit Type description",
            "example":"Kit A"
        },
        "packageTypeId":{
            "type":"number",
            "description":"Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).",
            "format":"double",
            "example":2,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10
            ]
        },
        "packageType":{
            "type":"string",
            "description":"Package Type",
            "example":"INHALER",
            "enum":[
                "BLISTERPACK",
                "BOTTLE",
                "DEVICE",
                "SYRINGE",
                "OINTMENT",
                "VIAL",
                "INHALER",
                "INFUSION",
                "BOX",
                "OTHER"
            ]
        }
    },
    "description":"Contains kit type details."
}

Nested Schema : dispensationDetails

Type: array

Show Source

Array of: object KitDispensationDTO

Title: KitDispensationDTO

Contains kit dispensation details.

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

Nested Schema : KitDispensationDTO

Type: object

Title: KitDispensationDTO

Contains kit dispensation details.

Show Source

dispensationDate: string (date-time)

Dispensation date
inventoryStatus: number (double)

Inventory status Id.

Example: 5
kitNumber: number (double)

Kit nuumber.

Example: 5

{
    "title":"KitDispensationDTO",
    "type":"object",
    "properties":{
        "kitNumber":{
            "type":"number",
            "description":"Kit nuumber.",
            "format":"double",
            "example":5
        },
        "inventoryStatus":{
            "type":"number",
            "description":"Inventory status Id.",
            "format":"double",
            "example":5
        },
        "dispensationDate":{
            "type":"string",
            "description":"Dispensation date",
            "format":"date-time"
        }
    },
    "description":"Contains kit dispensation details."
}

400 Response

Invalid parameters

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
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

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."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

404 Response

Invalid study ID or version. Or subject not found

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
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

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."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

500 Response

Internal server error

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
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

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."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.