Client.Login

Description

Verifies and logs in the client account

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
  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

Client.PasswordRemind

Description Sends the password reset email. Request Parameters Command =...

Client.PasswordReset

Description Resets clients password and sends the new password with email. Request Parameters...

Client.Create

Description Create new client account Request Parameters APIKey = {string} (required) The API...

Client.Update

Description Update client account information Request Parameters APIKey = {string}...

Clients.Get

Description Retrieves clients of logged in user. Request Parameters APIKey = {string}...