Support and Documentation


Important!
This documentation has been deprecated. We are migrating Oempro help articles to our new help portal. Take a look at more detailed help articles on our new help portal.

Sections:

  1. Description
  2. Oempro Version
  3. Request Parameters
  4. Response Parameters
  5. Error Codes

Client.Login

Description

Verifies and logs in the client account

Oempro Version

4+

Request Parameters

Command = {Client.Login} (required)
API Command
ResponseFormat = {JSON | XML} (required)
Response format
JSONPCallBack = {bool}
Send this parameter for cross-domain. More info about JSONP can be found here: http: //en.wikipedia.org/wiki/JSON#JSONP
Username = {string} (required)
Username of the client to be logged in
Password = {string} (required)
Password of the client to be logged in
RememberMe = {string} (required)
Stores the login information in the cookie

Response Parameters

Success = {true | false}
States if there is an error or not
ErrorCode = {integer}
If there is an error, error's code
SessionID = {string}
SessionID of the logged in user

Error Codes

1
Username is missing
2
Password is missing
3
Invalid login information
99998
Authentication failure or session expired
99999
Not enough privileges

Stay connected!