Merk op, het afsprakenstelsel DSGO is nog in ontwikkeling. Zie de Aanpak ontwikkeling afsprakenstelsel voor meer informatie. Voor vragen of opmerkingen neem contact op met afsprakenstelseldsgo@digigo.nu
Abonnement op een gebeurtenis
Een abonnement op een gebeurtenis is een gestandaardiseerde datadienst die de partij (die zich op voorhand heeft geabonneerd op meldingen over een (type) gebeurtenis) inlicht over deze gebeurtenis. Het concept van een abonnement is relevant voor veel partijen in de gebouwde omgeving. Om de werking van abonnementen te formaliseren in het DSGO definieert het afsprakenstelsel een abonnement als een gestandaardiseerde datadienst. Partijen (inclusief datadienstaanbieders) zijn niet verplicht een abonnement te implementeren. Een partij die kiest om een abonnement aan te bieden is vrij om een gebeurtenis te definiëren die voor haar relevant is. Deze termen worden in de tabel hieronder beschreven.
Een abonnement speelt een belangrijke rol wanneer een datadienstgebruiker (met toestemming van de datarechthebbende) op de hoogte gehouden wil worden van gebeurtenissen (bijvoorbeeld wijzigingen van de brondata) door middel van notificaties van de datadienstaanbieder op bepaalde resources.
Term | Omschrijving |
Een identificeerbaar en specifiek voorval zoals gedefinieerd door de datadienstaanbieder. Bijvoorbeeld het wijzigen van de brondata. | |
Een overeenkomst tussen een datadienstaanbieder en een datadienstgebruiker (met toestemming van de datarechthebbende) om notificaties te ontvangen over de gedefinieerde gebeurtenissen. | |
Een melding van een gebeurtenis van de datadienstaanbieder, ontvangen door de datadienstgebruiker onder de voorwaarde van een abonnement. |
Interactiemodel
Het onderstaande figuur illustreert in een interactiemodel hoe een abonnement tot stand komt en hoe notificaties van gebeurtenissen worden doorgegeven.
Merk op, in dit voorbeeld interactiemodel doet een datadienstgebruiker een abonnement verzoek bij een datadienstaanbieder. Een abonnement verzoek en abonnement response kan in het DSGO door iedere rol verstuurd worden afhankelijk van de situatie. Bijvoorbeeld een datadienstaanbieder die een abonnement verzoek verstuurt naar een marktvoorziening.
# | Acties | Omschrijving |
1 | Abonneren verzoek | De datadienstgebruiker initieert het abonneren op een gebeurtenis door middel van een abonnement verzoek naar de datadienstaanbieder. Hierbij moet de datadienstgebruiker voldoen aan alle voorwaarde van het abonnement zoals gedefinieerd door de datadienstaanbieder. |
2 | Abonneren response | De datadienstaanbieder valideert het abonnement verzoek tegen de voorwaarde (zoals gedefinieerd door de datadienstaanbieder, b.v. kosten van het abonneren) van het abonnement en stuurt een geschikte response naar de datadienstgebruiker. |
3 | Gebeurtenis | De datadienstaanbieder monitort de resource voor gebeurtenissen zoals beschreven in de abonnementsvoorwaarde. |
4 | Notificatie | De datadienstaanbieder stuurt de datadienstgebruiker een notificatie wanneer een gebeurtenis plaatsvindt. |
Wanneer een partij een notificatie ontvangt van een wijziging waarop de partij een abonnement heeft kan de partij er voor kiezen om in actie te komen (zoals het ophalen van aangepaste data) of niet.
Een verzoek op een abonnement wordt mogelijk gemaakt door een /subscriptions endpoint. Notificaties worden door partijen ontvangen door middel van een webhook url.
DSGO.Basis: Als een partij een abonnement wil aanbieden in het DSGO dan MOET de partij dit mogelijk maken met een /subscriptions endpoint
DSGO.Basis: Als een partij een abonnement wil gebruiken in het DSGO dan MOET de partij notificaties kunnen ontvangen op een webhook url