Order Management System REST API - Order Controller
The order/for/<owner> URI provides access to known Orders for a specific Owner.
Retrieve Orders for an Owner
Section titled “Retrieve Orders for an Owner”GET /order/for/<owner>
Retrieves all Orders for the Owner known to OMS.
Requires the Operator or Admin feature permissions.
URL Parameters
Section titled “URL Parameters”| Parameter | Description |
|---|---|
| owner | A URL-encoded Owner Code. |
Query Parameters
Section titled “Query Parameters”| Parameter | Expected | Description |
|---|---|---|
| asAt | Optional | An ISO8601 date and time. The results returned will be those at the given timestamp. If omitted, returns the latest results. |
| onlyActive | Optional | Boolean. When true, only returns orders that remain active. Orders with a status marked IsComplete will be omitted. |
Response
Section titled “Response”| Code | Status | Description |
|---|---|---|
| 200 | Success | Content is an array of OrderState objects. |
| 404 | Failure | Owner does not exist, or the authenticated identity does not have permission to see this owner. |