Error Messages

Brick uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, etc.). Codes in the 5xx range indicate an error with Brick’s servers (these are rare).

Error Object

📘

Always verify the response body

The return of the request will show the reason why it was not allowed by Brick's servers.

The erros inside Brick API will always be returned with the following schema:

{
  "code": "<UPPER_CASE_STRING>",
  "message": "Human readable string"
}

The response body, as we saw at the Standard Returns section, will always return the same schema. Therefore, every request to Brick API will receive a list of Errors Objects as return. It can be empty or it can have values.

{
	"data": null,
  "status": 400,
  "errors": [
    {
      "code": "RECORD_MISSING_DOCUMENT",
      "message": "Document not found!"
    },
    {
    	"code": "RECORD_MISSING_ENTITY_TYPE",
      "message": "Entity type is required when creating a Record. It must be PF/PJ"
    }
  ]
}

Standard Errors

4xx Client Error

5xx Server Error

Brick API has a system to monitor 500 status code errors.

Specific Errors

Create Record Errors

Find Record By Id Errors

Support

If you are having trouble with our API, please reach us through our support number with the largest amount of details as possible.

Here are a few informations that might help us debug it:

• The Environment
• Request Path
• Request Method
• HTTP error code
• JSON sent
• JSON received
• The time of the request
• Print screen
• Origin IP