Jump to

• Request
• Response

Get details of orders

get

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

Retrieves details of the orders. In this version, tempExcursionNumber is added to return temperature excursion number of the kit in an order. If a kit list is disabled, the shipment will be excluded from the Orders API. Rights: OrsInventoryGet, OrsUnblinded.

Request

Path Parameters

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

Query Parameters

• endDate(required): string
  The ending date and time (optional). If you don't specify the time, the date range stops before midnight (23:59:59 UTC) for the specified date. The accepted date and time formats are: dd-MMM-yyyy HH:mm:ss.SSS, dd-MMM-yyyy HH:mm:ss, or dd-MMM-yyyy HH:mm.
• includeDepotShipments(required): boolean
  By Default this value is set to False, which the default API will exclude depot to depot shipments.

  Default Value: false
• includeReconShipments(required): boolean
  By Default this value is set to False, which the default API will exclude destruction shipments.

  Default Value: false
• limit: integer(int32)
  Minimum Value: 1
• offset: integer(int32)
  Minimum Value: 0
• startDate(required): string
  The starting date and time (optional). If you don't specify the time, the date range begins after midnight (UTC) for the specified date. The accepted date and time formats are: dd-MMM-yyyy HH:mm:ss.SSS, dd-MMM-yyyy HH:mm:ss, or dd-MMM-yyyy HH:mm.
• status: string
  Status of the order

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : OrderInventoryPagedListResponse v6.0

Type: object

Title: OrderInventoryPagedListResponse v6.0

Contains order details for the inventory.

Show Source

• count: integer (int32)
• hasMore: boolean
• limit: integer (int32)
• offset: integer (int32)
• resultData: array resultData
• shipments: array shipments
• totalResults: integer (int32)

{
    "title":"OrderInventoryPagedListResponse v6.0",
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "offset":{
            "type":"integer",
            "format":"int32"
        },
        "resultData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OrderInventoryDTOV6"
            }
        },
        "shipments":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OrderInventoryDTOV5"
            }
        }
    },
    "description":"Contains order details for the inventory."
}

Nested Schema : resultData

Type: array

Show Source

• Array of: object OrderInventoryDTO v6.0
  Title: OrderInventoryDTO v6.0

  Contains inventory order details.

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

Nested Schema : shipments

Type: array

Show Source

• Array of: object OrderInventoryDTO v5.0
  Title: OrderInventoryDTO v5.0

  Contains inventory order details.

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

Nested Schema : OrderInventoryDTO v6.0

Type: object

Title: OrderInventoryDTO v6.0

Contains inventory order details.

Show Source

• inventory: array inventory
• order: object OrderDTO v3.0
  Title: OrderDTO v3.0

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

  Example: 1

{
    "title":"OrderInventoryDTO v6.0",
    "type":"object",
    "properties":{
        "order":{
            "$ref":"#/components/schemas/OrderDTOV3"
        },
        "inventory":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/InventoryDTOV3"
            }
        },
        "version":{
            "type":"integer",
            "description":"Version.",
            "format":"int32",
            "example":"1"
        }
    },
    "description":"Contains inventory order details."
}

Nested Schema : inventory

Type: array

Show Source

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

  Contains kit details.

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

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
  isDepotShipment

  Example: true
• isReconciliation: boolean
  isReconciliation

  Example: true
• jobInstanceId: string (uuid)
  Job instance Id.
• objectVersionNumber: number (double)
  Software version Number

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

  Operation type.

  Example: CREATED
• orderDate: string (date-time)
  Date of order
• orderId: string (uuid)
  Order Id.
• orderStatusId: number (double)
  Order status Id.

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

  Order type.

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

  Example: 5
• reason: string
  reason

  Example: DATA ENTRY ERROR
• reportId: string (uuid)
  report Id.
• shipDate: string (date-time)
  Date of shipping.
• shipmentId: string
  ID of the shipment.

  Example: 123
• siteId: string (uuid)
  ID of the site
• siteVersionStart: string (date-time)
  Site version start.
• studyId: string (uuid)
  ID of the study
• studyVersionStart: string (date-time)
  Study version start.
• trackingNumber: string
  Shipment tracking number.

  Example: 12345
• trackingNumberUrl: string
  Tracking number url.

  Example: http://www.site.com
• userId: string (uuid)
  User Id.
• versionEnd: string (date-time)
  Version End
• versionStart: string (date-time)
  Version Start

{
    "title":"OrderDTO v3.0",
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "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":"Date of order",
            "format":"date-time"
        },
        "orderStatusId":{
            "type":"number",
            "description":"Order status Id.",
            "format":"double",
            "example":"5"
        },
        "studyId":{
            "type":"string",
            "description":"ID of the study",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"Study version start.",
            "format":"date-time"
        },
        "siteId":{
            "type":"string",
            "description":"ID  of the site",
            "format":"uuid"
        },
        "siteVersionStart":{
            "type":"string",
            "description":"Site version start.",
            "format":"date-time"
        },
        "shipDate":{
            "type":"string",
            "description":"Date of shipping.",
            "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 number url.",
            "example":"http://www.site.com"
        },
        "orderType":{
            "type":"string",
            "description":"Order type.",
            "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"
        },
        "operationType":{
            "type":"string",
            "description":"Operation type.",
            "example":"CREATED",
            "enum":[
                "CREATED",
                "MODIFIED",
                "REMOVED"
            ]
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Software version Number",
            "format":"double",
            "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":"isReconciliation",
            "example":true
        },
        "reportId":{
            "type":"string",
            "description":"report Id.",
            "format":"uuid"
        },
        "isDepotShipment":{
            "type":"boolean",
            "description":"isDepotShipment",
            "example":true
        },
        "orderId":{
            "type":"string",
            "description":"Order Id.",
            "format":"uuid"
        }
    },
    "description":"Contains order related details."
}

Nested Schema : InventoryDTO v3.0

Type: object

Title: InventoryDTO v3.0

Contains kit details.

Show Source

• Block number: string
  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)
  Id of the Inventory
• 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
  Kit number UTF8.

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

  Example: 5
• siteId: string (uuid)
  ID of the site
• siteVersionStart: string (date-time)
  Site version start
• tempExcursionNumber: string
  Temperature excursion number

  Example: 001
• versionEnd: string (date-time)
  Version End
• versionStart: string (date-time)
  Version Start

{
    "title":"InventoryDTO v3.0",
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "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",
            "format":"date-time"
        },
        "labelGroupId":{
            "type":"string",
            "description":"Label group Id.",
            "format":"uuid"
        },
        "labelGroupVersionStart":{
            "type":"string",
            "description":"Label group version start",
            "format":"date-time"
        },
        "lotId":{
            "type":"string",
            "description":"Lot Id.",
            "format":"uuid"
        },
        "lotVersionStart":{
            "type":"string",
            "description":"Lot version start",
            "format":"date-time"
        },
        "sequenceNumber":{
            "type":"number",
            "description":"Sequence nuumber.",
            "format":"double",
            "example":"5"
        },
        "siteId":{
            "type":"string",
            "description":"ID  of the site",
            "format":"uuid"
        },
        "siteVersionStart":{
            "type":"string",
            "description":"Site version start",
            "format":"date-time"
        },
        "kitNumber":{
            "type":"number",
            "description":"Kit number.",
            "format":"double",
            "example":"5"
        },
        "inventorySourceId":{
            "type":"string",
            "description":"Id of the Inventory",
            "format":"uuid"
        },
        "inventorySourceVersionStart":{
            "type":"string",
            "description":"Inventory version start",
            "format":"date-time"
        },
        "kitNumberUTF":{
            "type":"string",
            "description":"Kit number UTF8.",
            "example":"24-1"
        },
        "Block number":{
            "type":"string",
            "description":"Block number.",
            "example":"245"
        },
        "tempExcursionNumber":{
            "type":"string",
            "description":"Temperature excursion number",
            "example":"001"
        },
        "blocknumber":{
            "type":"string",
            "writeOnly":true
        },
        "inventoryId":{
            "type":"string",
            "description":"Inventory Id.",
            "format":"uuid"
        }
    },
    "description":"Contains kit details."
}

Nested Schema : OrderInventoryDTO v5.0

Type: object

Title: OrderInventoryDTO v5.0

Contains inventory order details.

Show Source

• inventory: array inventory
• order: object OrderDTO v3.0
  Title: OrderDTO v3.0

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

  Example: 1

{
    "title":"OrderInventoryDTO v5.0",
    "type":"object",
    "properties":{
        "order":{
            "$ref":"#/components/schemas/OrderDTOV3"
        },
        "inventory":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/InventoryDTOV3"
            }
        },
        "version":{
            "type":"integer",
            "description":"Version.",
            "format":"int32",
            "example":"1"
        }
    },
    "description":"Contains inventory order details."
}

Nested Schema : inventory

Type: array

Show Source

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

  Contains kit details.

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

400 Response

Invalid order status value

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 : 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