Kit Errors
Learn about the standard formatting of errors and the importance of robust error handling.
Bright Kit should have a strict error structure when responses are 4XX or 5XX HTTP codes.
Format
The standard error format we 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 Kit and the steps Bright Energy takes afterwards.
Code | Description | Next Steps |
---|---|---|
501 | Not Implemented | If expected to be available, a Customer Success Manager will reach out to check on the delivery status of this endpoint. |
Updated 2 months ago