Errors

Zūm Rails wraps all API responses in the same JSON format, and the HTTP status is also returned as part of the response body in the statusCode field.

Success Response

{
    "statusCode": 200,
    "message": "POST Request successful.",
    "isError": false,
    "result": {
    }
}

Error Response

{
    "statusCode": 400,
    "isError": true,
    "responseException": {
       "exceptionMessage": {
        }
    }
}

The Zūm Rails API uses the following http error codes:

Error Code	Meaning
400	Bad Request -- Your request is invalid.
401	Unauthorized -- Your API key is wrong.
403	Forbidden -- The endpoint requested is hidden for administrators only.
404	Not Found -- The specified endpoint or entity could not be found.
429	Too Many Requests -- You reached your quota
500	Internal Server Error -- We had a problem with our server. Try again later.