ErrorMessage

Extends

Extensible

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Field Required Nullable Type Description Constraints Example

@type

Yes

No

String

When sub-classing, this defines the sub-class Extensible name

default null;

@baseType

No

No

String

When sub-classing, this defines the super-class

default null;

@schemaLocation

No

No

String

A URI to a JSON-Schema file that defines additional attributes and relationships

default null;

code

Yes

No

String

Application relevant detail, defined in the API or a common list.

default null;

0995

reason

Yes

No

String

Explanation of the reason for the error which can be shown to a client user.

default null;

human error

message

No

No

String

More details and corrective actions related to the error which can be shown to a client user.

default null;

Datenstruktur unzulässig.

status

No

No

String

HTTP Error code extension

default null;

not found

referenceError

No

No

URI

URI of documentation describing the error.

default null;

https://api.example.org/error/id