Errors
In the event of an error, all API endpoints will return an HTTP Response with a status code as well as a response body with more information. Error bodies will be a JSON object with the following shape:
Key-Value Pairs In an Error Response
Key | Resource Type | Description |
---|---|---|
error | boolean | true if an error occurred |
code | string | An HTTP Status Code - should correspond to the code of the response |
message | string | A human-readable description of the error |
detail | string | Likely empty, but may contain additional details |