Skip to main content

Format

The BBrands API will respond with errors that follow a defined structure for Accounts, Licenses, Products, Subscriptions and others resources. The error messages will have the following format:
{
  "error":{
    "code": "BBXYYYZZZ",
    "errors": ["<string>"],
    "message": "Some descriptive message"
  },
  "meta": {
    "correlation": "<string>",
    "status": "<number>",
    "timestamp": "<string>"
  }
}
The purpose of this section is to understand the structure of the code field within the API response by providing a catalog listing the possible codes that the API can return along with their corresponding descriptions.

Structure of the error code

Errors will have the following syntax
With the following sources
0
Not Explicit Type
1
Expected
2
Database
3
Validation
4
Rules