Jump to

• Request
• Response

v1.0

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventorystatuses/site

Retrieves a site inventory status by study ID. Rights: OrsInventoryGet.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

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 InventoryStatus
  Inventory status

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

Nested Schema : InventoryStatus

Type: object

Inventory status

Show Source

• inventoryStatus: string
  Allowed Values: [ "Available", " Damaged", " Destroyed", " Dispensed", " Expired", " Not in Use", " Misallocated", " Missing", " In Transit", " Quarantined", " Pre-quarantined", " Pending Destruction", " Lost by Subject", " Temporarily Unavailable", " Damaged by Subject", " New", " Not Dispensed to Subject", " Returned to Site", " Conserved", "Received for Destruction" ]

  Inventory status

  Example: New, Damaged
• inventoryStatusId: integer (int64)
  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: 1

{
    "type":"object",
    "properties":{
        "inventoryStatus":{
            "type":"string",
            "description":"Inventory status",
            "example":"New, Damaged",
            "enum":[
                "Available",
                " Damaged",
                " Destroyed",
                " Dispensed",
                " Expired",
                " Not in Use",
                " Misallocated",
                " Missing",
                " In Transit",
                " Quarantined",
                " Pre-quarantined",
                " Pending Destruction",
                " Lost by Subject",
                " Temporarily Unavailable",
                " Damaged by Subject",
                " New",
                " Not Dispensed to Subject",
                " Returned to Site",
                " Conserved",
                "Received for Destruction"
            ]
        },
        "inventoryStatusId":{
            "type":"integer",
            "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":"int64",
            "example":1,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10,
                11,
                12,
                13,
                14,
                15,
                16,
                17,
                18,
                19,
                20
            ]
        }
    },
    "description":"Inventory status",
    "example":{
        "inventoryStatusId":1,
        "inventoryStatus":"Available"
    }
}

Example:

{
    "inventoryStatusId":1,
    "inventoryStatus":"Available"
}

Examples

Select an example Get Site User Inventory Statuses Response

404 Response

Invalid study ID or version

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

Examples

Select an example Get Site User Inventory Statuses Not Found Response

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

Examples

Select an example Get Site User Inventory Statuses Server Error Response

Back to Top