Common API error codes

The following lists error information common to the APIs.

Status

The following error codes can be returned for the request.

400:
An invalid parameter was specified, or there is an error in the JSON data format specified in the request body.
401:
Authentication error. An authentication token does not exist or contains an error.
404:
A URL that does not exist or an incorrect URL was specified.
500:
Service internal error.
503:
The service cannot be used temporarily.
504:
Processing was not completed within a certain period (one minute).
Data type Cardinality
int 1..1

The following error information is returned:

Response headers

Content-Length

Request length excluding the header (in bytes).

Data type Cardinality
String 1..1

Content-Type

Type of contents.

text/plain:
If the status is 401.
application/json:
If the status is not 401.
Data type Cardinality
String 1..1

Date

Datetime of the response.

Data type Cardinality
String 1..1

WWW-Authenticate

URL of the authentication service (only output for authentication errors).

Data type Cardinality
String 0..1

Response elements

error_message

Container for error information.

Data type Cardinality Parent element Child element
Element 1..1 None debuginfo

faultcode

faultstring

debuginfo

Debug information.

Data type Cardinality Parent element Child element
String 1..1 error_message None

faultcode

Error code.

Data type Cardinality Parent element Child element
String 1..1 error_message None

faultstring

Error message.

Data type Cardinality Parent element Child element
String 1..1 error_message None

Example of response


{
    "error_message": {
        "debuginfo": null,
        "faultcode": "Client",
        "faultstring": "Invalid input for field/attribute limit. Value: 'a'. unable to convert to int"
    }
}