OrderAmendReply
Reply message in response to the OrderAmend message. It contains the standard fields that describe the response to a message. By examining the values of the message fields it is possible to determine the outcome of the message.
- Section: Transactions
- Related Message: OrderAmend
ResultCode - The result of the message. In general, 0 means success and a number other than zero means failure.
ErrorParam - If ResultCode is nonzero, the ErrorParam may be set in order to determine which field the error relates to. If set, it is the KVP number of the field which caused the error. For example, if the ResultCode is
ERROR_PERMISSION_DENIED, the ErrorParam allows the caller to determine which entity in the transaction they do not have permission for.
Metadata
- Message Type: ReplyMessage
- Message Number: 1502
Inherited fields
| Name | Type | Size (bytes) | Description |
|---|---|---|---|
| MessageType | Integer (unsigned) | 2 | The unique identifier of this message. |
| ClientId | Integer (unsigned) | 4 | The unique identifier of a session with the server, returned in a successful LoginReply message. |
| RequestId | Integer (unsigned) | 4 | Within each session each message must be uniquely identified by this field. It must be monotonically increasing for the duration of the session. |
| ResultCode | Integer (signed) | 4 | The result of the message. In general, 0 means success and a number other than zero means failure. |
| ErrorParam | Integer (unsigned) | 2 | If ResultCode is nonzero, the ErrorParam may be set in order to determine which field the error relates to. If set, it is the KVP number of the field which caused the error. For example, if the ResultCode is ERROR_PERMISSION_DENIED, the ErrorParam allows the caller to determine which entity in the transaction they do not have permission for. |
Fields
| Name | Type | Size (bytes) | Description |
|---|---|---|---|
| Id | Foreign key to Order | 8 | The Id of the new Order created by the amendment. |
| ClOrdID | String | 60 | For FIX orders, the Client OrderId of the new Order created by the amendment. |
| OrigClOrdID | String | 60 | For FIX orders, the Client OrderId of the original Order that was amended. |
| Status | Set of OrderStatus | 4 | |
| TotalBalance | Integer (signed) | 8 | The total quantity remaining unmatched for the new Order created by the amendment. This is the absolute size of the remaining quantity for the Order inclusive of any hidden quantity. |
| VisibleBalance | Integer (signed) | 8 | The current visible balance of the new Order created by the amendment after any matching has taken place. This is the part of the total balance that is currently displayed in the Order book. |
| HiddenBalance | Integer (signed) | 8 | The remaining hidden quantity for the new Order created by the amendment. This is the part of the total balance that is currently hidden from the market. |
| Limit | Integer (signed) | 8 | If there is an error where a limit will be breached, preventing the Order amendment, this is the value of the limit that will be breached. |
| Type | Set of OrderType | 4 |