API Responses

Response Envelope

    "validationErrors": []

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

dataobjectThe response data
timeinitthe time, in milliseconds, for the server to process the request
errorintThe error code, if the request was unsuccessful.
For a successful response the error will always be -1
error_descriptionstringHuman-readable description of the error.
successfulbooleantrue if a successful request, otherwise false.
validationErrorsValidationError ArrayArray of validations (if any)


The API returns standard HTTP status codes.