notification object

Deze pagina’s zijn in het engels ten behoeve van mogelijk internationale ontwikkelaars


This object is used in the following endpoints:


Information about notifications related to events are provided in notification objects, as defined below.

Parameters

Description

Parameters

Description

id

Required

MUST be the unique identifier of the notification.

resource_type

Required

MUST be a string representing the object type, equal to notification.

date

Required

Date and time that the notification was sent, MUST be a UNIX timestamp, following the timestamp conventions.

consumer_id

Required

MUST be a unique identifier of the data service consumer as an Organisation ID, containing an EORI or KvK number.

provider_id

Required

MUST be a unique identifier of the data service provider as an Organisation ID, containing an EORI or KvK number.

subscription_id

Required

MUST be a unique identifier of the subscription under which the event is monitored.

description

Optional

MUST contain a human-readable description of the notification as a string.

event

Required

MUST be an event object, as defined here, containing data regarding the event which triggered the notification.

{ "id" : "not_123", "resource_type" : "notification", "date" : "1663752228", "consumer_id" : "EU.EORI.NL000123456", "provider_id" : "EU.EORI.NL000345678", "subscription_id" : "sub_123", "description" : "Detailed description of the notification", "event" : [ { "id" : "eve_123", "object_type" : "event", "event_type" : "Modified", "date" : "1663752217", "description" : "Detailed description of the event", "event_data" : "Data record xyz has been modified by zyx" } ] }

Event object

Parameters

Description

Parameters

Description

id

Required

MUST be the unique identifier of the event.

resource_type

Required

String representing the object type, MUST be equal to event.

event_type

Required

MUST be the label of the type of event that has taken place. Exact values to be defined by a specific data service. For example: Modified, Deleted, Moved, Created.

date

Required

Date and time that the event took place, MUST be a UNIX timestamp, following the timestamp conventions.

description

Optional

MUST contain a human-readable description of the event which triggered the notification as a string.

event_data

Optional

MUST contain data related to the event

{ "id" : "eve_123", "resource_type" : "event", "event_type" : "Modified", "date" : "1663752217", "description" : "Detailed description of the event", "event_data" : "Data record xyz has been modified by zyx" }