Bright API follows the same error structure as Kit Errors for HTTP responses in the 4XX or 5XX range.

Format

The standard error format you can expect to receive is:

{
  "name": "GenericError",
  "message": "An error of some origin has occurred.",
  "status": 400,
  "error": true,
  "key": "1056",
  "uid": "25198069-6171-410c-bfed-5e0666402c08"
}

name is camelCase capitalised.
message is a long form detailed description of what the error is.
status is the HTTP code of the error.
error is a boolean to signify if the response is an error. This format can be used in other response types.
key is the numeric or string value of the unique error type.
uid is the debug id.

Errors

A list of common errors returned from the Bright API and the next steps to take afterwards.