API Errors

API Errors

On error the API will respond with the appropriate HTTP error code and a JSON object detailing what went wrong. This JSON object looks something like this:

    {
        "type": "http://codepoints.net/api/v1/problem/not_found",
        "title": "Not a block",
        "status": 404
    }

The type, title and status fields are always present. They categorize the error. Additional information is available under the URL given in type.

There might be other fields present in the response, such as description or an URI template for correct API calls.

The Problem Details RFC states, that the content type of the response should be application/problem+json in case of error. If you want to receive this content type, please add it to the Accept header of your request.