Request
Body
Firm Status Post -
FirmStatusPost
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
child
|
Child |
String
|
REQUIRED | ||
parent
|
Parent |
String
|
REQUIRED |
The Firm identifier of the firm you want the status of |
|
tradable
|
Tradable |
String
|
|
REQUIRED |
If the the firm can trade or not |
Response - 200
Body
Firm Status Post Res -
FirmStatusPostRes
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
parent
|
Parent |
String
|
CONDITIONAL |
Present when the firm is not a parent. |
|
children[]
|
Children |
FirmStatus
|
Firm Status -
FirmStatusPostRes.children[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
firm
|
Firm ID |
String
|
ALWAYS |
The Firm identifier of the firm you want the status of |
|
killEvent
|
Kill Event |
String
|
CONDITIONAL |
If the firm is killed the way in which it was killed Directly or indirectly by a Firm or the Exchange itself |
|
tradable
|
Tradable |
String
|
|
ALWAYS |
If the the firm can trade or not |
Response - 201
Created
Response - 401
Unauthorized
Response - 403
Body
Error Message -
ErrorMessage
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
errors[]
|
Errors |
Error
|
Error -
ErrorMessage.errors[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
code
|
Code |
String
|
|
ALWAYS | |
message
|
Message |
String
|
ALWAYS | ||
referenceIndex
|
Reference Index |
Integer
|
ALWAYS |
Forbidden
Response - 404
Not Found