All API function calls will use the following JSON format for responses:
{
"status": "success",
"message": "",
"data": {
"Field_1": "Value1",
"Field_2": 2
}
}
The data is returned within a JSON object that contains three (3) properties:
| Field | Description |
|---|---|
| status | The status of the response (either ‘success’ or ‘error’) |
| message | If not blank, contains a message to be displayed to the user. Typically, only errors populate this field with a description of the error. |
| data | If status = ‘success’, contains either a null value, a JSON object of the type specified in the function description, or an array of these objects. |
Unless otherwise specified, error responses only contain a message – they don’t contain any data:
{
"status": "error",
"message": "The error message",
"data": null
}