Login

Log in to the System

Metadata

  • Message Type: TransactionMessage
  • Message Number: 6001

Inherited fields

NameTypeSize (bytes)Description
MessageTypeInteger (unsigned)2The unique identifier of this message.
ClientIdInteger (unsigned)4The unique identifier of a session with the server, returned in a successful LoginReply message.
RequestIdInteger (unsigned)4Within each session each message must be uniquely identified by this field. It must be monotonically increasing for the duration of the session.

Fields

NameTypeSize (bytes)Description
SessionIdInteger (unsigned)2Session for this login.
UserIdString200The text user identifier for the user logging in.
PasswordString128The password for the user logging in.
ResetFlagInteger (unsigned)1Set to 1 to reset (forget) the user's saved replies from the previous session or 0 to keep saved replies from previous session.
TimeoutInteger (unsigned)4The Timeout field in the Login request specifies the time in seconds after which, if there is no activity on the session that the user will be logged out automatically and the session will become free (this field is currently ignored by the System as it is managed globally for all users but it may be used in the future).
ProtocolVersionString20'The version of the protocol being used.
TokenInteger (unsigned)4A token which is echoed back in the reply message to this transaction.