Order Management System REST API - Account Controller
The account/byid/<owner>/<account> URL manipulates Trading Account metadata for individual accounts.
Retrieve a Trading Account
Section titled “Retrieve a Trading Account”GET /account/byid/<owner>/<account>
Retrieves the metadata for a Trading Account.
URL Parameters
Section titled “URL Parameters”| Parameter | Description |
|---|---|
| owner | A URL-encoded Owner Code. |
| account | A URL-encoded Account ID unique to the Owner. |
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. |
Response
Section titled “Response”| Code | Status | Description |
|---|---|---|
| 200 | Success | The Trading Account was found. Content is a single AccountDetails object. |
| 404 | Failure | Owner or Trading Account metadata does not exist, or the authenticated identity does not have permission to see this account. |
Rename a Trading Account
Section titled “Rename a Trading Account”PATCH /transform/rename/account
Changes all references within OMS from one Owner/Account to a different Owner/Account.
URL Parameters
Section titled “URL Parameters”| Parameter | Description |
|---|---|
| owner | A URL-encoded Owner Code. |
| account | A URL-encoded Account ID unique to the Owner. |
Query Parameters
Section titled “Query Parameters”| Parameter | Expected | Description |
|---|---|---|
| newOwner | Optional | The new Owner Code. If omitted, defaults to the original Owner Code. |
| newAccount | Optional | The new Account ID. If omitted, defaults to the original Account Code. |
POST Body
Section titled “POST Body”A single TransformRequest object.
Response
Section titled “Response”| Code | Status | Description |
|---|---|---|
| 204 | Success | The transformation was applied. |
| 403 | Failure | The authenticated identity does not have the Alter permission. |
| 404 | Failure | Owner or Trading Account metadata does not exist, or the authenticated identity does not have permission to see this account. |
| 422 | Failure | A failure occurred. Content is a JSON array of one or more error codes describing the problem. |
Remove a Trading Account
Section titled “Remove a Trading Account”DELETE /account/byid/<owner>/<account>
Removes the metadata for a Trading Account.
Requires the Alter feature permission.
URL Parameters
Section titled “URL Parameters”| Parameter | Description |
|---|---|
| owner | A URL-encoded Owner Code. |
| account | A URL-encoded Account ID unique to the Owner. |
Response
Section titled “Response”| Code | Status | Description |
|---|---|---|
| 204 | Success | The Trading Account was removed. |
| 403 | Failure | The authenticated identity does not have the Alter permission. |
| 404 | Failure | Owner or Trading Account metadata does not exist, or the authenticated identity does not have permission to see this account. |
| 422 | Failure | A failure occurred. Content is a JSON array of one or more error codes describing the problem. |