Wijzigingshistoriek

Situering

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

Verwante diensten

RegistreerInschrijving 2.0: Voor het inschrijven of het uitbreiden van bestaande inschrijvingsperiodes.

Gegevensbronnen

Voor deze dienst is geen leverancier van toepassing. De uitschrijvingen 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 Informatie Vlaanderen tijdens het aansluitingsproces.

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

Gebruiksvoorwaarden

Afnemers moeten aan volgende voorwaarden voldoen om deze webservice te mogen gebruiken:

• Toelating tot het MAGDA platform

Meer informatie over deze voorwaarden is terug te vinden in het document “Machtigingen en toelatingen” [MT].

Batch

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

Deze webservice is eveneens beschikbaar in een batch-variant (enkel XML). Voor meer informatie: Webservice In Batch bevragen.

Functionaliteiten

De webservice RegistreerUitschrijving laat de gebruiker toe te melden dat deze niet langer een dossier heeft lopen van een persoon en dit optioneel voor een bepaalde periode. Concreet gaat dit om het verwijderen of aanpassen van een eerder gedane inschrijving. De melding gebeurt door minstens het doorsturen van de INSZ van de betrokken persoon. Optioneel kunnen ook een begin- en/of 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: optioneel

o   begindatum: optioneel

                              o    einddatum: optioneel 

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

Werking

Opties

Volgende configuratieparameters kunnen 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 MAGDA af of de uitschrijving in het MAGDA inschrijvingsrepertorium gebeurt en/of in het inschrijvingsregister van KSZ.

Opvraging

Bij de registratie van een uitschrijving wordt deze, afhankelijk van de afspraken tussen de afnemer en Informatie Vlaanderen in het MAGDA inschrijvingsrepertorium en/of in het KSZ inschrijvingsregister doorgevoerd.

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

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

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

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

Het uitschrijven van een INSZ dat niet is ingeschreven, of niet is ingeschreven voor de gekozen periode zal een “Niet geslaagd” geven met in de uitzondering de melding dat er geen inschrijving is.

Voor een INSZ dat vervangen is door een nieuw INSZ zal KSZ een uitzondering 30004 gestuurd worden en een “Niet geslaagd”. Een vervangen INSZ is bij KSZ niet meer actief en kan daardoor niet meer in- of uitgeschreven worden.

Werking bij INSZ met meerdere of overlappende inschrijvingen:

• Indien er wordt geprobeerd een INSZ uit te schrijven dat meerdere inschrijvingen voor verschillende tijdsvorken heeft dan worden alle inschrijvingsperiodes met een begin- of einddatum in de gekozen uitschrijvingsperiode verwijderd of aangepast. Een bestaande inschrijving die volledig buiten de gekozen uitschrijvingsperiode valt blijft bestaan.
• Valt de gekozen uitschrijvingsperiode deels of volledig binnen een bestaande inschrijving dan wordt deze inschrijving aangepast. Een INSZ dat bv. was ingeschreven van 2012-10-01 tot en met 2012-10-30 en wordt uitgeschreven voor 2012-10-09 tot en met 2012-10-12 zal nog steeds ingeschreven blijven voor de periode van 2012-10-01 tot en met 2012-10-08 en de periode van 2012-10-13 tot en met 2012-10-30. Met andere woorden: de inschrijving is nu door deze uitschrijving in twee delen gesplitst.
• Een uitschrijving met enkel een begin- of enkel een einddatum verwijdert alle inschrijvingen respectievelijk vanaf de begindatum of tot en met de einddatum.
• Een uitschrijving zonder periode verwijdert alle inschrijvingen, ook al waren er meerdere inschrijving voor de INSZ.

Responsetijden & Beschikbaarheid

De webservice op het MAGDA platform is 24 uur op 24 en 7 dagen op 7 beschikbaar. Als de uitschrijvingen 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.