Search orders in the given date range matching the status
get
/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders
Searches for orders in a given date range matching a status. 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.
-
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 TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Type:
Show Source
array
-
Array of:
object OrderInventoryDTO v1.0
Title:
OrderInventoryDTO v1.0
Contains inventory order details.
Nested Schema : OrderInventoryDTO v1.0
Type:
object
Title:
OrderInventoryDTO v1.0
Contains inventory order details.
Show Source
-
inventory: array
inventory
-
order: object
OrderDTO v1.0
Title:
OrderDTO v1.0
Contains order related details. -
version: integer
(int32)
Version.Example:
1
Nested Schema : inventory
Type:
Show Source
array
-
Array of:
object InventoryDTO v2.0
Title:
InventoryDTO v2.0
Contains kit details.
Nested Schema : OrderDTO v1.0
Type:
object
Title:
OrderDTO v1.0
Contains order related details.
Show Source
-
depotId: string
(uuid)
Depot Id.
-
depotVersionStart: string
(date-time)
Depot version start.
-
jobInstanceId: string
(uuid)
Job instance Id.
-
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
-
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
-
versionEnd: string
(date-time)
Version End
-
versionStart: string
(date-time)
Version Start
Nested Schema : InventoryDTO v2.0
Type:
object
Title:
InventoryDTO v2.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
-
versionEnd: string
(date-time)
Version End
-
versionStart: string
(date-time)
Version Start
400 Response
Invalid order status value
Nested Schema : result
Type:
object
Nested Schema : details
Type:
object
500 Response
Internal server error
Nested Schema : result
Type:
object
Nested Schema : details
Type:
object