Deze pagina’s zijn in het engels ten behoeve van mogelijk internationale ontwikkelaars
This endpoint MAY be implemented by the following roles:
DATA SERVICE PROVIDER DATA SERVICE BROKER TRUST FRAMEWORK CATALOGUE
Subscriptions allow data service consumers to get notifications for specific events as defined by a data service provider. Within the trust framework, subscriptions are managed in phases, find more information in the lifecycle of subscriptions. The subscription resource has been defined to structure all relevant parameters of these elements and available actions throughout the lifecycle of a subscription. If data service providers decide a subscription is applicable to their situation, this must be implemented in accordance to the resources as defined here.
DSGO.Basis
: Data service providers MUST define subscriptions for events in accordance to the subscription
resource, when implementing a subscription
DSGO.Basis
: Data service providers MUST define events for their subscriptions in accordance to the events
resource, when implementing a subscription
Subscription resource
Parameters | Description | |
---|---|---|
| Required | MUST contain a unique identifier of the subscription. |
| Required | String representing the resource type, MUST be equal to |
| Required | URL of the subscription. |
| Required | Date time when the subscription was initially created, MUST be a UNIX timestamp, following the timestamp conventions. |
| Required | Contains the date time when the subscription becomes/became valid, MUST be a UNIX timestamp, following the timestamp conventions. |
| Optional | If the subscription has an end date, or has ended, contains the end date and time, MUST be a UNIX timestamp, following the timestamp conventions. |
| Required | If the subscription is assigned a data service consumer MUST contain a unique identifier of the data service consumer as an Organisation ID, containing an EORI or KvK number. |
| Required | MUST contain a unique identifier of the data service provider as an Organisation ID, containing an EORI or KvK number. |
| Optional | MUST contain a human-readable description of the subscription as a string. |
| Required | MUST be a list with subset of event types that is subscribed to, selected from the list defined by the data service provider. |
| Required | MUST be the status of the subscription. Possible values are: |
| Required | MUST be the URL of the data service consumer that notifications shall be sent to. |
Endpoint
The /subscriptions
endpoint allows data service consumers to perform a number of different functions on the subscriptions defined by a data service provider. All subscriptions APIs should follow the generic technical requirements, as well as the requirements specified for specific methods. Further, data service providers are responsible for determining a suitable authorisation policy for their subscriptions. See Autorisatie for more information.
DSGO.Basis
: Data service providers MUST expose their subscriptions in conformance with the DSGO /subscriptions
endpoint specifications
DSGO.Basis
: Data service providers MUST determine suitable authorisation policy for their /subscriptions
endpoint
The figure below gives an overview of the HTTP methods that are supported by the /subscriptions
endpoint. These methods are further detailed and specified in the pages below: