The API uses standard HTTP response codes to indicate the success or failure of requests. Statuses in the 2xx
range indicate success; statuses in the 4xx
and 5xx
ranges indicate errors. The format of error messages is unified, and can be distinguished by their status
key. The title
and detail
are plain English explanations of the problem.
{
"status": "status_code",
"id": "A unique identifier for this particular occurrence of the problem.",
"title": "A short, human-readable summary of the problem.",
"detail": "A human-readable explanation specific to this occurrence of the problem.",
}