Document toolboxDocument toolbox


DIGITAAL VLAANDEREN

Algemeen.GeefMutatiesNotificaties-02.01

Informatie:

Voor de ontsluiting van een MAGDA 2.0 webservice, alsook het generieke proces binnen een 2.0 webservice, wordt verwezen naar Werking en gebruik MAGDA 2.0 Webservices.

Situering

Opmerking:

Gelieve eerst de Algemeen.MutatieNotificatie overzicht documentatie te lezen om de PubliceerMutatieNotificatie 02.01 (bron) dienst te kunnen plaatsen in het MAGDA platform.

De 02.01 versie van deze dienst laat toe om een veel ruimer palet van sleutels te ontvangen zoals INSZ (PERS), ondernemingsnummer (OND), perceelnummer, … . Daarbij kan ook per notificatie een lijst ontvangen worden van wat aan het opgegeven subject gewijzigd is, dit zonder het meesturen van de feitelijke gegevens.
De volledige gegevens van de sleutel kunnen opgevraagd worden via de geef-dienst gerelateerd aan de sleutel. Zo worden bij een notificatie van een INSZ nummer de volledige gegevens van een persoon opgevraagd via de GeefPersoon dienst. Hieronder een schematische voorstelling van dit proces

Verwante diensten

De andere MutatiesNotificaties 02.01 diensten spelen hun rol in het dataverkeer van de mutatie notificaties. Zie hiervoor de overzichtspagina voor meer informatie.

Gegevensbronnen

Er worden geen gegevens opgevraagd bij authentieke bronnen. De authentieke bronnen registreren of publiceren mutaties in de registers van MAGDA. De Algemeen.GeefMutatieNotificatie 02.01 dienst geeft de notificaties weer voor een bepaalde opgegeven sleutel waarvoor in het register een registratie gevonden is.

Opmerking:

Agentschap Digitaal Vlaanderen is afhankelijk van de externe bron(nen) voor de kwaliteit en de aanlevering van de gegevens. 

Gebruiksvoorwaarden

Om gebruik te kunnen maken van deze dienst dient men een machtiging te hebben die toegang geeft tot deze gegevens en een aansluitingsprocedure te doorlopen.

Batch

Deze webservice is niet beschikbaar in een batch-variant.

Functionaliteiten

De notificaties die door de bron naar MAGDA gestuurd worden komen in een database. Vanuit deze database worden bestanden aangemaakt door het MAGDA publicatie framework PubMut 2.0 die maximaal 7 notificaties bevatten. De GeefMutatieNotificatie 02.01 dienst stelt deze bestanden ter beschikking via een webservice door de informatie in een SOAP bericht te vervatten. Voorbeeld: Als de bron 100 notificaties geregistreerd heeft bij MAGDA zullen dus 15 bestanden aangemaakt worden (100 / 7 = 14.3).
De bron kan met een bepaalde frequentie de gegevens ter beschikking stellen en MAGDA kan met een bepaalde frequentie de gegevens uit de database naar de bestanden schrijven waardoor ze ter beschikking staan voor de afnemer. Deze twee frequenties worden vermeld in de bron specifieke bijlage.

Vraag

De vraag bestaat uit de identificatie en hoedanigheid van de afnemer, er kan eventueel een ontvangstreferte meegegeven worden indien de afnemer eerder een opvraging had gedaan en die referte gebruikt om het ‘vervolg’ op te vragen.

Antwoord

Het antwoord bevat de gewijzigde sleutel, het type sleutel, het type verandering, het tijdstip van verandering en welke bron deze verandering geregistreerd heeft. Indien er geen notificaties meer beschikbaar zijn wordt een leeg antwoord teruggestuurd. Het antwoord bevat ook een referentie welke gebruikt wordt in het opvragen van de volgende mutatie.

Werking

Aandachtspunten

Er zijn geen specifieke aandachtspunten voor deze dienst.

Opties

Volgende configuratieparameters kunnen ingesteld worden in functie van de machtigingen en de wensen van de afnemer:

  • Indien je als afnemer van deze dienst ook mutaties registreert via de RegistreerMutatieNotificatie webservice of de PubliceerMutatieNotificate 02.01 dienst, bestaat de mogelijk om de eigen geregistreerde mutaties niet te ontvangen. Indien gewenst wordt dit het best gemeld tijdens het aansluitingsproces. Al is het mogelijk om dit tijdens het productief zijn te laten wijzigen.

Opvraging

Na registratie van mutatienotificaties door de bron worden deze door het MAGDA publicatie framework PubMut 2.0 op geregelde tijdstippen verdeeld naar de gemachtigde afnemers. De verdeling kan gebeuren op basis van gegevens in de notificatie (vb. de NIS code voor verdeling naar gemeentes).

De verdeelde mutatienotificaties worden daarna bewaard op het MAGDA platform. De afnemer kan via de GeefMutatiesNotificaties webservice deze bewaarde mutaties op de door hem gewenste tijdstippen ophalen.

Verdeelde mutatienotificaties hebben intern drie statussen:

  1. Nieuwe mutatienotificaties : de mutatienotificaties zijn verdeeld en beschikbaar voor ophaling door de afnemer

  2. Opgehaald maar nog niet bevestigd: de afnemer heeft de mutatienotificaties opgehaald maar nog niet bevestigd door een nieuwe vraag inclusief ontvangstreferte

  3. Bevestigd: de mutatienotificaties zijn opgehaald en bevestigd door de afnemer. Als gevolg hiervan zijn de mutatienotificaties niet meer beschikbaar voor ophaling (gearchiveerd)

Wordt een mutatienotificatie opgehaald door de afnemer, dan verkrijgt die mutatienotificatie de status 2. Door middel van de ontvangstreferte bevestigt de afnemer bij de volgende vraag de goede verwerking van de mutatienotificaties. De mutatienotificaties verkrijgen dan status 3. De afnemer bekomt in het antwoord de volgende klaarstaande mutatienotificaties die status 2 verkrijgen met een nieuwe ontvangstreferte.

De mutatienotificaties met status 3 worden gearchiveerd en zijn niet beschikbaar voor de afnemer.

Per antwoord met mutatienotificaties kunnen er maximaal 7 mutatienotificaties terugkomen. Zijn er geen mutatienotificaties beschikbaar verkrijgt de afnemer een foutmelding (zonder ontvangstreferte!).

Ophaalperiodiciteit

Het ophalen van de gegevens gebeurt het best periodiek, bijvoorbeeld elke 60 minuten. Elke 60 minuten wordt er dan door de toepassing bij de afnemer door het aanroepen van de GeefMutatiesNotificaties 02.01 gecontroleerd of er mutatienotificaties aanwezig zijn.

Zijn mutatienotificiaties aanwezig, dan worden deze in één cyclus opgehaald tot er geen mutatienotificaties meer beschikbaar zijn. Staan er geen mutatienotificaties (meer) klaar voor de afnemer, dan stopt de verwerking en wordt er pas in de volgende ophaalperiode opnieuw gecontroleerd.

Wat betreft de periodiciteit, de frequentie is door de afnemer zelf te bepalen en kan best afgestemd worden op de periodiciteit van het registreren van notificatie van de bron.

Onderstaande afbeelding toont het proces hoe dit werkt:

Responsetijden & Beschikbaarheid

Logging

De opvragingen die gebeuren via deze webservice worden bewaard zoals beschreven op de pagina "MAGDA logging".

Ondersteunde talen

MAGDA ondersteunt de Nederlandse taal.

Indien in de brongegevens de Nederlandse tekst niet beschikbaar is voor een bepaald element zal de eerste vertaling van de tekst in de brongegevens gebruikt worden, onafhankelijk van de taal waarin dit gegeven beschikbaar is.

Op deze pagina


Binnen deze handleiding


Omgevingsinformatie

Domein

Algemeen

Classificatie

Persoonsgegevens


Verwante diensten





















Voor vragen of opmerkingen kan u de MAGDA helpdesk contacteren

De MAGDA Gebruikersomgeving is een officiële website van de Vlaamse overheid

uitgegeven door Digitaal Vlaanderen