LoginReply
The reply to the Login transaction.
- Section: Connection and Authorisation
- Related Message: Login
The message response contains a number of fields that are for use by the client when interacting with the system;
ClientId- The key that must be submitted with all subsequent messages in this sessionUser- The identifier of the User associated with this User accountTradingSessionId- A unique number each time that the trading system is started from scratchDataResetFlag- If this number changes from one login to the next, it indicates that the client counters of messages etc should be reset.
Metadata
- Message Type: ReplyMessage
- Message Number: 6501
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 |
|---|---|---|---|
| User | Foreign key to User | 8 | |
| UserId | String | 200 | The string identifier of this User which is used to log in to the system. |
| TradingSessionId | Integer (unsigned) | 4 | |
| DataResetFlag | Integer (unsigned) | 4 | |
| Token | Integer (unsigned) | 4 |