File: WebAPI/user_session_2.proto
Result of the logon operation. This is a common message used in both trader-level (LogonRoutineServer) and account-level (account_authorization_2.AccountLogonRoutineServer) multi-step logon sequences as well as in the single step logon.
Request: Logon.
Relates to: LogonRoutineServer, account_authorization_2.AccountLogonRoutineServer
AccountLogonRoutineServer, LogonRoutineServer, ServerMsg
Type: uint32
Description: One of the logon result codes. This field is associated with the LogonResult.ResultCode enum type.
Type: string
Description: Base time as ISO 8601 string (e.g., ‘2013-04-03T14:23:20’) all other times (fields like *_time, e.g., LogonResult.server_time) are number of milliseconds from this base time.
Type: string
Description: Token of a new session if logon succeeded. Filled only for trader level logon procedure.
Type: string
Description: Optional logon result message for failure details.
Type: string
Description: URL for a client to reconnect in case of redirection.
Type: uint32
Description: Current protocol version of server. Normally client application needs nothing to do with it.
Type: uint32
Description: See: protocol_version_minor
Type: sint32
Description: Unique user identification.
Type: sint64
Description: Time when the message was sent.
Type: uint32
Description: Timeout for session inactivity, in
minutes. It is the client’s responsibility
to track activity and disable or
close the session after the timeout.
•RESULT_CODE_SUCCESS = 0
User is logged in to the system.
•RESULT_CODE_FAILURE = 101
General failure.
•RESULT_CODE_NO_ONETIME_PASSWORD = 103
One-time password is required for this user, but it was not sent, repeat logon with one-time password.
•RESULT_CODE_PASSWORD_EXPIRED = 104
User password is expired; only changing the password operation is allowed.
•RESULT_CODE_CONCURRENT_SESSION = 105
Failed because this user has a concurrent session that is not allowed for this application and drop was not requested.
•RESULT_CODE_REDIRECTED = 106
Client is redirected to a different server, new server is specified in redirectUrl.
•RESULT_CODE_ROUTINE_ERROR = 107
The negotiation rules for LogonRoutineClient have been violated, e.g., user has specified several fields at once in one message.
•RESULT_CODE_ACCESS_TOKEN_EXPIRED = 108
Access token is expired already.