Jump to

• Request
• Response

v4.0

get

/ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/orders/{shipmentId}

Retrieves an order's details by shipment ID. In this API, blockNumber and kitNumberUTF added to return block number and kit number in UTF-8. Rights: OrsInventoryGet, OrsUnblinded.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training.
• shipmentId(required): string
  ID of the shipment.
• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : Order Inventory v4.0

Type: object

Title: Order Inventory v4.0

Contains inventory order details.

Show Source

• inventory: array Inventory
  Title: Inventory

  List of inventory records.
• order: object OrderDTO v3.0
  Title: OrderDTO v3.0

  Contains order related details.
• version: integer (int32)
  Title: Version

  Version.

  Example: 1

{
    "title":"Order Inventory v4.0",
    "type":"object",
    "properties":{
        "order":{
            "$ref":"#/components/schemas/OrderDTOV3"
        },
        "inventory":{
            "title":"Inventory",
            "type":"array",
            "description":"List of inventory records.",
            "items":{
                "$ref":"#/components/schemas/InventoryDTO"
            }
        },
        "version":{
            "title":"Version",
            "type":"integer",
            "description":"Version.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Contains inventory order details."
}

Nested Schema : Inventory

Type: array

Title: Inventory

List of inventory records.

Show Source

• Array of: object InventoryDTO v2.0
  Title: InventoryDTO v2.0

  Contains details of inventories.

{
    "title":"Inventory",
    "type":"array",
    "description":"List of inventory records.",
    "items":{
        "$ref":"#/components/schemas/InventoryDTO"
    }
}

Nested Schema : OrderDTO v3.0

Type: object

Title: OrderDTO v3.0

Contains order related details.

Show Source

• comment: string
  Comment.

  Example: Updated with new values
• depotId: string (uuid)
  Depot ID.
• depotVersionStart: string (date-time)
  Depot version start.
• isDepotShipment: boolean
  Depot shipment indicator.

  Example: true
• isReconciliation: boolean
  Indicates whether kit reconciliation is included.

  Example: true
• jobInstanceId: string (uuid)
  Job instance ID.
• objectVersionNumber: number (BigDecimal)
  Object version number.

  Example: 5
• operationType: string
  Allowed Values: [ "CREATED", "MODIFIED", "REMOVED" ]

  Operation type.

  Example: CREATED
• orderDate: string (date-time)
  Order date.
• orderId: string (uuid)
  Order ID.
• orderStatusId: number (double)
  Order status ID.

  Example: 5
• orderType: string
  Allowed Values: [ "INITIAL", "RESUPPLY", "MANUAL" ]

  Order type (Manual or Resupply).

  Example: MANUAL
• orderTypeId: integer (int64)
  Order type ID.

  Example: 5
• reason: string
  Reason.

  Example: DATA ENTRY ERROR
• reportId: string (uuid)
  Report ID.

  Example: b1b8327a-faa6-4122-8710-6192ab5984ef
• shipDate: string (date-time)
  Ship date.
• shipmentId: string
  ID of the shipment.

  Example: 123
• siteId: string (uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
• siteVersionStart: string (date-time)
  Site version start date.
• softwareVersionNumber: number (BigDecimal)
  Software version number.

  Example: 5
• studyId: string (uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.
• studyVersionStart: string (date-time)
  Study version start.
• trackingNumber: string
  Shipment tracking number.

  Example: 12345
• trackingNumberUrl: string
  Tracking URL.

  Example: http://www.site.com
• userId: string (uuid)
  User ID.

  Example: b1b8327a-faa6-4122-8710-6192ab5984ef
• versionEnd: string (date-time)
  The end date until which the data is applicable or valid.
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

{
    "title":"OrderDTO v3.0",
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"The end date until which the data is applicable or valid.",
            "format":"date-time"
        },
        "depotId":{
            "type":"string",
            "description":"Depot ID.",
            "format":"uuid"
        },
        "depotVersionStart":{
            "type":"string",
            "description":"Depot version start.",
            "format":"date-time"
        },
        "jobInstanceId":{
            "type":"string",
            "description":"Job instance ID.",
            "format":"uuid"
        },
        "orderDate":{
            "type":"string",
            "description":"Order date.",
            "format":"date-time"
        },
        "orderStatusId":{
            "type":"number",
            "description":"Order status ID.",
            "format":"double",
            "example":5
        },
        "studyId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"Study version start.",
            "format":"date-time"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "format":"uuid"
        },
        "siteVersionStart":{
            "type":"string",
            "description":"Site version start date.",
            "format":"date-time"
        },
        "shipDate":{
            "type":"string",
            "description":"Ship date.",
            "format":"date-time"
        },
        "shipmentId":{
            "type":"string",
            "description":"ID of the shipment.",
            "example":"123"
        },
        "trackingNumber":{
            "type":"string",
            "description":"Shipment tracking number.",
            "example":"12345"
        },
        "trackingNumberUrl":{
            "type":"string",
            "description":"Tracking URL.",
            "example":"http://www.site.com"
        },
        "orderType":{
            "type":"string",
            "description":"Order type (Manual or Resupply).",
            "example":"MANUAL",
            "enum":[
                "INITIAL",
                "RESUPPLY",
                "MANUAL"
            ]
        },
        "orderTypeId":{
            "type":"integer",
            "description":"Order type ID.",
            "format":"int64",
            "example":5
        },
        "userId":{
            "type":"string",
            "description":"User ID.",
            "format":"uuid",
            "example":"b1b8327a-faa6-4122-8710-6192ab5984ef"
        },
        "operationType":{
            "type":"string",
            "description":"Operation type.",
            "example":"CREATED",
            "enum":[
                "CREATED",
                "MODIFIED",
                "REMOVED"
            ]
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number.",
            "format":"BigDecimal",
            "example":5
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software version number.",
            "format":"BigDecimal",
            "example":5
        },
        "reason":{
            "type":"string",
            "description":"Reason.",
            "example":"DATA ENTRY ERROR"
        },
        "comment":{
            "type":"string",
            "description":"Comment.",
            "example":"Updated with new values"
        },
        "isReconciliation":{
            "type":"boolean",
            "description":"Indicates whether kit reconciliation is included.",
            "example":true
        },
        "reportId":{
            "type":"string",
            "description":"Report ID.",
            "format":"uuid",
            "example":"b1b8327a-faa6-4122-8710-6192ab5984ef"
        },
        "isDepotShipment":{
            "type":"boolean",
            "description":"Depot shipment indicator.",
            "example":true
        },
        "orderId":{
            "type":"string",
            "description":"Order ID.",
            "format":"uuid"
        }
    },
    "description":"Contains order related details."
}

Nested Schema : InventoryDTO v2.0

Type: object

Title: InventoryDTO v2.0

Contains details of inventories.

Show Source

• blockNumber: string
  Title: Block Number

  Block number.

  Example: 245
• blocknumber: string
• doNotCount: number (double)
  Do Not Count (DNC) Days.

  Example: 5
• doNotShip: number (double)
  Do Not Ship (DNS) Days.

  Example: 5
• expirationDate: string (date-time)
  Expiration date.
• inventoryId: string (uuid)
  Inventory ID.
• inventorySourceId: string (uuid)
  Inventory ID.
• inventorySourceVersionStart: string (date-time)
  Inventory version start.
• inventoryStatusId: number (double)
  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
• kitNumber: number (double)
  Kit number.

  Example: 5
• kitNumberUTF: string
  Title: Kit Number UTF

  Kit number with UTF-8 support.

  Example: 24-1
• kitTypeId: string (uuid)
  ID of the kit type.
• kitTypeVersionStart: string (date-time)
  Kit type version start date.
• labelGroupId: string (uuid)
  Label group ID.
• labelGroupVersionStart: string (date-time)
  Label group version start date.
• lotId: string (uuid)
  Lot ID.
• lotVersionStart: string (date-time)
  Lot version start date.
• sequenceNumber: number (double)
  Sequence number.

  Example: 5
• siteId: string (uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
• siteVersionStart: string (date-time)
  Site version start date.
• versionEnd: string (date-time)
  The end date until which the data is applicable or valid.
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

{
    "title":"InventoryDTO v2.0",
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"The end date until which the data is applicable or valid.",
            "format":"date-time"
        },
        "doNotCount":{
            "type":"number",
            "description":"Do Not Count (DNC) Days.",
            "format":"double",
            "example":5
        },
        "doNotShip":{
            "type":"number",
            "description":"Do Not Ship (DNS) Days.",
            "format":"double",
            "example":5
        },
        "expirationDate":{
            "type":"string",
            "description":"Expiration date.",
            "format":"date-time"
        },
        "inventoryStatusId":{
            "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
            ]
        },
        "kitTypeId":{
            "type":"string",
            "description":"ID of the kit type.",
            "format":"uuid"
        },
        "kitTypeVersionStart":{
            "type":"string",
            "description":"Kit type version start date.",
            "format":"date-time"
        },
        "labelGroupId":{
            "type":"string",
            "description":"Label group ID.",
            "format":"uuid"
        },
        "labelGroupVersionStart":{
            "type":"string",
            "description":"Label group version start date.",
            "format":"date-time"
        },
        "lotId":{
            "type":"string",
            "description":"Lot ID.",
            "format":"uuid"
        },
        "lotVersionStart":{
            "type":"string",
            "description":"Lot version start date.",
            "format":"date-time"
        },
        "sequenceNumber":{
            "type":"number",
            "description":"Sequence number.",
            "format":"double",
            "example":5
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "format":"uuid"
        },
        "siteVersionStart":{
            "type":"string",
            "description":"Site version start date.",
            "format":"date-time"
        },
        "kitNumber":{
            "type":"number",
            "description":"Kit number.",
            "format":"double",
            "example":5
        },
        "inventorySourceId":{
            "type":"string",
            "description":"Inventory ID.",
            "format":"uuid"
        },
        "inventorySourceVersionStart":{
            "type":"string",
            "description":"Inventory version start.",
            "format":"date-time"
        },
        "kitNumberUTF":{
            "title":"Kit Number UTF",
            "type":"string",
            "description":"Kit number with UTF-8 support.",
            "example":"24-1"
        },
        "blockNumber":{
            "title":"Block Number",
            "type":"string",
            "description":"Block number.",
            "example":"245"
        },
        "blocknumber":{
            "type":"string",
            "writeOnly":true
        },
        "inventoryId":{
            "type":"string",
            "description":"Inventory ID.",
            "format":"uuid"
        }
    },
    "description":"Contains details of inventories."
}

500 Response

Internal server error

Body ()

Root Schema : DesignerResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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

Nested Schema : details

Type: object

Back to Top