Situering

Dit document beschrijft het gebruik en de werking van de webservice RegistreerInschrijving 2.0 zoals deze door Digitaal Vlaanderen op het MAGDA platform aangeboden wordt.

Verwante diensten

RegistreerUitschrijving 2.0 : Voor het aanpassen / verwijderen van geregistreerde inschrijvingen.

Gegevensbronnen

Voor deze dienst is geen leverancier van toepassing. De inschrijvingen gebeuren in het MAGDA inschrijvingsrepertorium en/of het KSZ inschrijvingsregister (het KSZ ‘inscriptionregister’). Dit hangt af van de machtigingen en instellingen in de MAGDA autorisatiedatabase en zal de afnemer afspreken met Digitaal Vlaanderen tijdens het aansluitingsproces.

Meer informatie over hoe deze bronnen gebruikt worden in de opbouw van het antwoord vindt u onder Opvraging.

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 eveneens beschikbaar in een batch-variant (enkel XML).

Meer informatie hierover kan u vinden via “Aansluiting op het MAGDA-platform” in het document “MS – Gebruikershandleiding_WebserviceInBatch”.

Voor meer informatie: Webservice In Batch bevragen.

Functionaliteiten

De webservice RegistreerInschrijving laat de gebruiker toe te melden dat deze een dossier heeft lopen van een persoon voor een bepaalde periode. De melding gebeurt door minstens het doorsturen van de INSZ van de betrokken persoon en een begindatum. Optioneel kan ook al een einddatum meegestuurd worden.

MAGDA gebruikt deze registraties voor de inschrijvingscontrole binnen verscheidene diensten en het verdelen van persoonsmutaties.

Als vraag wordt doorgestuurd:

• het INSZ van de persoon

• een periode

  • begindatum: verplicht

  • einddatum: optioneel. Indien deze parameter ontbreekt zal in de MAGDA database de datum 31 December 2099 als einddatum opgenomen worden.

Als antwoord verkrijgt men een “wel geslaagd” of “niet geslaagd”.

Zie ook Opvraging hieronder voor meer details over de inschrijivng bij KSZ en MAGDA.

Werking

Opties

Volgende configuratieparameter kan op het MAGDA platform ingesteld worden in functie van de machtigingen en de wensen van de afnemer:

• MAGDA en/of KSZ: de afnemer spreekt tijdens zijn aansluitingsprocedure met Digitaal Vlaanderen af of de inschrijving in het MAGDA inschrijvingsrepertorium gebeurt en/of in het inschrijvingsregister van KSZ.

Opvraging

Bij de registratie van een inschrijving wordt deze, afhankelijk van de afspraken tussen de afnemer en Digitaal Vlaanderen in het MAGDA inschrijvingsrepertorium en/of in het KSZ inschrijvingsregister bewaard.

Bij een succesvolle inschrijving verkrijgt de afnemer een antwoord “Wel geslaagd.”

Bij ontvangst van dit antwoord is de inschrijving voor alle inschrijvingsregisters voor de afnemer uitgevoerd.

Het is belangrijk aan te stippen dat de afnemer geen inschrijvingsregister kiest tijdens het concrete gebruik van deze dienst. Dit wordt volledig op voorhand bepaald door de afspraken die tijdens de aansluitingsprocedure gemaakt zijn met Digitaal Vlaanderen. De RegistreerInschrijving dienst zal daarna automatisch voor de afnemer de inschrijving doen in het MAGDA inschrijvingsrepertorium en/of het inschrijvingsregister van KSZ.

In het geval dat inschrijvingen voor de afnemer zowel bij MAGDA als KSZ dienen te gebeuren zal de dienst achterliggend altijd eerst de inschrijving bij KSZ proberen te doen. Indien hier een fout optreedt omdat bv. KSZ niet beschikbaar is zal er ook bij MAGDA geen inschrijving meer gebeuren en zal er een foutmelding worden teruggestuurd. Indien de inschrijving eerst bij KSZ goed zou gaan en vervolgens bij MAGDA zou falen zal er ook een foutmelding teruggestuurd worden. Voor afnemers die inschrijvingen doen in de twee registers betekent een “Wel geslaagd” dus dat de inschrijving geslaagd is in de twee registers. Bij een “Niet geslaagd” is er in minstens een van de twee registers geen inschrijving gebeurd en dient de inschrijving opnieuw te gebeuren. Indien inschrijvingen gedurende langere tijd niet zouden lukken, zonder dat er een communicatie is geweest van Digitaal Vlaanderen, dient er contact opgenomen te worden met helpdesk.magda@vlaanderen.be.

Werking bij meerdere inschrijvingen voor eenzelfde INSZ:

• Indien er wordt geprobeerd een INSZ in te schrijven dat al ingeschreven is zal de dienst geen fout teruggeven maar opnieuw de inschrijving bevestigen naar de afnemer met een “Wel geslaagd.”

• Een nieuwe inschrijving voor eenzelfde INSZ heft niet de vorige inschrijving op. Een INSZ kan dus ingeschreven zijn voor verschillende tijdsvorken. Het is dus mogelijk om bv. eerst een inschrijving te doen van een bepaald INSZ voor 2012-10-13 tot en met 2012-10-14 en dan een inschrijving te doen voor hetzelfde INSZ voor 2012-10-17 tot en met 2012-10-19. Beide tijdsvorken zullen dan opgeslagen zijn. Voor de periode tussen de twee tijdsvorken is het INSZ echter niet ingeschreven.

Een nieuwe inschrijving voor eenzelfde INSZ kan wel een vorige inschrijving uitbreiden. Indien de tijdsvorken van de inschrijving elkaar overlappen zal de totale inschrijving worden uitgebreid. Dit geldt ook als er bv. eerst een inschrijving wordt gedaan voor een bepaald INSZ voor 2012-10-12 tot en met 2012-10-14 en vervolgens voor hetzelfde INSZ vanaf 2012-10-13 zonder einddatum. Er zal dan uiteindelijk een inschrijving zijn vanaf 2012-10-12 zonder einddatum.

Actieve, Overlap en Ooit inschrijvingscontrole

Het type inschrijving dient aangevraagd te worden bij de aansluiting. Zonder specificatie zal een Actieve inschrijvingscontrole gebruikt worden.

Actieve inschrijvingscontrole

Standaard zal MAGDA een actieve inschrijvingscontrole toepassen.

Voor de synchrone (SOAP of REST) diensten zal bij de vraag nagegeken worden of het INSZ op het moment van bevraging ingeschreven is in het repertorium waarbij dat de systeemdatum in de periode moet liggen van de inschrijving van het gebruikte INSZ.

Voor de asynchrone diensten (ftp) zullen berichten doorgestuurd worden naar de gebruiker indien het INSZ dat aan het bericht gekoppeld is ingeschreven is in het repertorium waarbij de systeemdatum in de periode moet liggen van de inschrijving van het gebruikte INSZ.

Overlap inschrijvingscontrole

Dit type van inschrijvingscontrole is enkel beschikbaar voor een beperkt aantal diensten. Hierbij wordt een periode in de vraag (synchrone diensten) of het bericht (asynchrone diensten) vergeleken met de periode van inschrijving in het repertorium voor een INSZ. Indien er minimaal 1 dag een overlap is tussen beide periodes zal de vraag of het bericht doorgaan. Indein bij het inschrijven in het repertorium van een INSZ de einddatum niet ingevuld wordt zal 31 december 2099 gebruikt worden als einddatum. Zie ook https://vlaamseoverheid.atlassian.net/wiki/spaces/MG/pages/6356075913

Ooit inschrijvingscontrole

Bij een Ooit inschrijvingscontrole wordt nagegeken of het INSZ uit het bericht voorkomt in het repertorium zonder rekening te houden met de data. Het opgegeven periode bij inschrijving worden hier niet in rekening gebracht. Zie ook https://vlaamseoverheid.atlassian.net/wiki/spaces/MG/pages/6357811201

Responsetijden & Beschikbaarheid

De webservice op het MAGDA platform is 24 uur op 24 en 7 dagen op 7 beschikbaar. Als de inschrijvingen voor de afnemer bij KSZ of bij MAGDA en KSZ dienen te gebeuren is deze webservice ook afhankelijk van de beschikbaarheid van de externe partij KSZ.

Bij geplande onbeschikbaarheden worden de afnemers op de hoogte gebracht.

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

Verwante diensten