ErrorCode Object

Some DELETE, POST, and PUT operations do not return an object upon success. If the operation results in an error, it returns the ErrorCode object.

The ErrorCode object includes the following properties:

code

integer

The API error code.

Example: 

"code": 113

specificCode

integer

An error code returned by an external service.

Example: 

"specificCode": 0

httpStatus

integer

The HTTP status code.

Example: 

"httpStatus": 401

name

string

The error name.

Example: 

"name": "Unauthorized"

description

string (optional)

The error description, if available.

Example: 

"description": "Invalid or missing authorization header"

The preceding list order reflects the sequence in which the data returns.

The following is a full ErrorCode object example:

{
  "code": 113,
  "specificCode": 0,
  "httpStatus": 401,
  "name": "Unauthorized",
  "description": "Invalid or missing authorization header"
}