Error Objects

The DIDWW API returns error objects in JSONAPI format. Each error includes a title, detail, code, and status to help you diagnose issues.

Validation Error Object

A validation error occurs when a request contains invalid or missing data.

Name	Type	Nullable	Description
`title`	string	False	Short error description.
`detail`	string	False	Detailed error description.
`code`	string	False	Always returns `100`.
`pointer`	string	False	Path to the error attribute or relationship in the request payload.

Can’t Be Blank Error Object

This validation error occurs when a required attribute is missing from the request.

Name	Type	Nullable	Description
`title`	string	False	Always returns `can’t be blank`.
`detail`	string	False	Field-specific message describing which required attribute is missing.
`code`	string	False	Always returns `100`.
`pointer`	string	False	Path to the missing attribute in the request payload.
`status`	string	False	HTTP status code `422`.

Bad Request Error Object

This error occurs when the request contains an invalid or not allowed parameter or attribute.

Name	Type	Nullable	Description
`title`	string	False	Short error description, for example `Param not allowed`.
`detail`	string	False	Detailed message describing which parameter or attribute is not allowed.
`code`	string	False	Error-specific code, for example `105` for a parameter that is not allowed.
`status`	string	False	HTTP status code `400`.

Not Found Error Object

This error occurs when the requested resource cannot be found.

Name	Type	Nullable	Description
`title`	string	False	Record not found.
`detail`	string	False	The record identified by `{id}` could not be found.
`code`	string	False	Always returns `404`.
`status`	string	False	HTTP status code `404`.

Insufficient Balance Error Object

This error occurs when your account balance is too low to complete the request.

Name	Type	Nullable	Description
`title`	string	False	Insufficient balance.
`detail`	string	False	Insufficient balance.
`code`	string	False	HTTP status code or error code returned by the API, for example `400`.
`status`	string	False	HTTP status code `400`.
`meta.total_cost`	string	False	Total cost of the current order only.
`meta.available_balance`	string	False	Customer balance including credit at the time of the check.

Example

{
  "errors": [
    {
      "title": "Insufficient balance",
      "detail": "Insufficient balance",
      "code": "400",
      "status": "400",
      "meta": {
        "total_cost": "5.67",
        "available_balance": "1.5"
      }
    }
  ]
}

Conflict Error Object

This error occurs when a request conflicts with the current state of the resource (for example, when trying to delete a resource that has dependencies).

Name	Type	Nullable	Description
`title`	string	False	Conflict.
`detail`	string	False	Resource-specific message describing the conflict.
`code`	string	False	Always returns `409`.
`status`	string	False	HTTP status code `409`.