POST api/user/AuthenticateUser?EmailAddress={EmailAddress}&Password={Password}&ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}

This method allows you to authenticate user credentials based on username and password.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
EmailAddress

Primary Key, use the email address for Register, Update, Enable, Disable and Retrieve.

string

Required

Password

Password that will be the secret key to log in.

string

Required

ApplicationKey

The application identity issued by an authorized publisher of Traxia services. This identity is unique and generated one-time during registration.

string

Required

APIKey

Secret key issued to be challenged as identity verification.

string

Required

DeviceID

Unique code to identify a device that connects to the Traxia system, such as IMEI.

string

None

Body Parameters

None

Response Information

Resource Description

BaseResponse
NameDescriptionTypeAdditional Information
Acknowledge

Acknowledgement of API request format, whether you are submitting the requested parameter in a proper format.

Acknowledge

None

ResponseCode

Indicates the result of your API service process. Negative results may have different code indicators depending on their failure type.

ResponseCode

None

ResponseMessage

Negative API process results may have additional information in text to explain the failure reasons.

string

None

Data

Data provide a universal object response model transformed into JSON compatible format. You will need to recognize the type of returned object model of each of your request. For more information about object class model, please consult our object class library documentation.

Object

None

Latency

integer

None

Response Formats

application/json, text/json

Sample:

Sample not available.