LoginRequest

Note

For a more in depth documentation, you should check the comments from the protobuf file.

Purpose

Used to authenticate the client.

Warning

The client should wait for the login response, before sending any other request. If the client sends a request before receiving the response for the login request, the server will close the connection.

Mandatory fields

The mandatory fields for the login request are:

  • username - Client username.

  • password - Client password.

  • firmId - id of firm, to which the data were issued, default value: “CVS”.

  • mobileType - default value: “NEWLITE”,

  • localIP - local IP Adress, default value: “0.0.0.0”,

  • clientVersion - “1.0.0”,

  • clientUniqueId - QST customers will receive this ID when they sign up for service, along with the login credentials.


Request example

const loginRequest = {
  username: "username",
  passord: "hash_password",
  firmId: "CVS",
  mobileType: "NEWLITE",
  localIP: "0.0.0.0",
  clientVersion: "1.0.0",
  clientUniqueId: "c5c2257b-86da-4822-8ea7-0357018f15e3"
}

Responses

Login succeeded

If the provided login credentials are valid, the server will respond with a LoginResponse.


Login failed

If the login failed, the server will respond with an LoginResponse, where in field “serverMessage” saves reason of failing