All the responses are served as JSON.
The response format is based on JSend specification. That means every API response have the following fields:
The status associated with the response. The value can be:
- success: The request was resolved successfully. Associated with
2xxHTTP status code.
- fail: The request failed. Probably a missing or wrong value for a parameter. Associated with
4xxHTTP status code.
- error: Uh oh. Something unexpected happened. Associated with
5xxHTTP status code.
A simple rule here is, if the request was resolved successfully, then the
successstatus will be associated. In other case check for
The API response payload.
An human readable extra information, such as an error message or explanation.
An additional link pointing to external resource for reading more about