Jump to

• Request
• Response

v3.0

get

/ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history

Retrieves dispensation history. Rights: OrsSubjectVisitGet.

Request

Path Parameters

• externalSubjectId(required): string(uuid)
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.
• mode(required): string
  Mode of the study, accepts: test, active, or training.
• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

Query Parameters

• visitId(required): string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit

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 DispensationHistoryResponse v2.0
  Title: DispensationHistoryResponse v2.0

  Response object containing Dispensation History.

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

Nested Schema : DispensationHistoryResponse v2.0

Type: object

Title: DispensationHistoryResponse v2.0

Response object containing Dispensation History.

Show Source

• balanceUnits: number (double)
  Title: Balance Units

  Balanced units for the kit.

  Example: 1
• dispensationDate: string (date-time)
  Title: Dispensation Date

  Dispensation date.
• inventoryId: string (uuid)
  Title: Inventory ID

  Inventory ID.
• inventoryStatus: number (double)
  Title: Inventory Status

  Allowed Values: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20 ]

  Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).

  Example: 5
• kitDescription: string
  Title: Kit Description

  Kit description.

  Example: Kit A
• kitNumber: number (double)
  Title: Kit Number

  Kit number.

  Example: 5
• lastModifiedDate: string (date-time)
  Title: Last Modified Date

  Last modified date.
• missingUnits: number (double)
  Title: Missing Units

  Missing units for the kit.

  Example: 1
• packageTypeId: number (double)
  Title: Package Type ID

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

  Package type ID.

  Example: 5
• returnedUnits: number (double)
  Title: Returned Units

  Returned units for the kit.

  Example: 1
• siteId: string (uuid)
  Title: Site ID

  Site ID.
• unitsPerKit: number (double)
  Title: Units Per Kit

  Units per kit.

  Example: 1

{
    "title":"DispensationHistoryResponse v2.0",
    "type":"object",
    "properties":{
        "kitNumber":{
            "title":"Kit Number",
            "type":"number",
            "description":"Kit number.",
            "format":"double",
            "example":5
        },
        "inventoryStatus":{
            "title":"Inventory Status",
            "type":"number",
            "description":"Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).",
            "format":"double",
            "example":5,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10,
                11,
                12,
                13,
                14,
                15,
                16,
                17,
                18,
                19,
                20
            ]
        },
        "dispensationDate":{
            "title":"Dispensation Date",
            "type":"string",
            "description":"Dispensation date.",
            "format":"date-time"
        },
        "inventoryId":{
            "title":"Inventory ID",
            "type":"string",
            "description":"Inventory ID.",
            "format":"uuid"
        },
        "packageTypeId":{
            "title":"Package Type ID",
            "type":"number",
            "description":"Package type ID.",
            "format":"double",
            "example":5,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10
            ]
        },
        "unitsPerKit":{
            "title":"Units Per Kit",
            "type":"number",
            "description":"Units per kit.",
            "format":"double",
            "example":1
        },
        "returnedUnits":{
            "title":"Returned Units",
            "type":"number",
            "description":"Returned units for the kit.",
            "format":"double",
            "example":1
        },
        "missingUnits":{
            "title":"Missing Units",
            "type":"number",
            "description":"Missing units for the kit.",
            "format":"double",
            "example":1
        },
        "balanceUnits":{
            "title":"Balance Units",
            "type":"number",
            "description":"Balanced units for the kit.",
            "format":"double",
            "example":1
        },
        "siteId":{
            "title":"Site ID",
            "type":"string",
            "description":"Site ID.",
            "format":"uuid"
        },
        "lastModifiedDate":{
            "title":"Last Modified Date",
            "type":"string",
            "description":"Last modified date.",
            "format":"date-time"
        },
        "kitDescription":{
            "title":"Kit Description",
            "type":"string",
            "description":"Kit description.",
            "example":"Kit A"
        }
    },
    "description":"Response object containing Dispensation History."
}

400 Response

Invalid parameters

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• 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

Show Source

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

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

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

404 Response

Invalid study ID or version. Or subject not found.

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• 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

Show Source

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

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

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• 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

Show Source

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

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

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

Back to Top