API Response Format

Overview

An HTTP code of 200 is responded for each successful data requests. If there is any error exists, an HTTP code other than 200 will be given as well as platform Error Code and error description.

Success

A valid request made using current credentials will return a 200 response. The body of the response will be a JSON file starting as follows:

{
 "result": "success",
 "server_time": "2017-10-09T08:48:34Z",
 ......
}

Failure

An invalid request or a request that cannot be authenticated will result in returning an error code (4XX or 5XX). The body of the response will give detailed information as in this example:

{
 "result": "error",
 "server_time": "2017-10-09T08:53:18Z",
 "errorCode": "permission_denied_force_log_off",
 "desp": "account_key, or token_id is not correct"
}

Every failed request will include an errorCode and desp field giving more details.

List of Error Codes