Response Envelope

{
    "data":{},
    "time":50,
    "error":-1,
    "error_description":null,
    "successful":true,
    "validationErrors": []
}

All API responses, including errors, shall be wrapped with the following response envelope unless otherwise stated.

Key	DataType	Description
`data`	object	The response data
`time`	init	the time, in milliseconds, for the server to process the request
`error`	int	The error code, if the request was unsuccessful. For a successful response the `error` will always be -1
`error_description`	string	Human-readable description of the error.
`successful`	boolean	`true` if a successful request, otherwise `false`.
`validationErrors`	ValidationError Array	Array of validations (if any)

Errors

The API returns standard HTTP status codes.