2.2.3.3. error

Entity: error

The error entity is intended for communicating error messages, primarily used within the API-framework.

Example usage

Below is an example error entity, filled with some attributes. This example shows a check of the POR code at the moment of receival of the message. The message cannot be processed and is returned immediately with an error message. See AFD 2.0 Online for the complete and up-to-date data catalog with all available entity types and associated attributes listed under the error entity. More documentation on the use of SIVI AFS is available in chapter Where to find elements of SIVI AFS.

{
	"error": [ {
		"entityType": "default",
		"httpStatus": "400",
		"errorCode": "01",
		"errorCodeExplanation": "Onbekende maatschappij-aanduiding",
		"errorDescription": "Bad request"
	} ]
}

Entity types

There are no entity types within the error entity. Entities without an entity type always use “default” as the value for the mandatory entityType attribute (see example above). The error entity corresponds to the FM entity in AFD 1.0, plus new (mostly API-framework related) attributes.