Notes
JSON is used for all API responses. The request arguments are normally form-urlencoded arguments (Content-Type: application/x-www-form-urlencoded; charset=UTF-8), except for APIs that only accept a request body. In those cases, the request body should be JSON, and the Content-Type for the request should be application/json; charset=UTF-8. Note that UTF-8 should be used as the charset.
Notes: Standard Response
The success version of the Standard Response is used by a few APIs for success responses. Other APIs use a specific success object that relates to the API. See the specific API call for more information.
The error version of the Standard Response is used by all APIs to indicate error responses.
A success response will be an object with the following properties (only used by some APIs):
- ids (array): Any IDs affected by the API call. May be empty
- result (boolean): Value of true
- error (object): null
An error response will be an object with the following properties (this is the error response returned from all APIs):
- ids (array): Any IDs affected by the API call. May be empty
- result (object): null if the API call has an error
- error (object): An object with the following properties:
- name (string): an error type name
- message (string): An English description of the error