Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info
titleInformatie:

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.


Excerpt
hiddentrue

Deze dienst is een uitbreiding op de GeefGezinssamenstelling herwerking van de WijzigKSZPersoon-02.00 naar aanleiding van de KSZ v4 services upgrade. Het laat een gebruiker toe om de gezinssamenstelling persoonsgegevens van een persoon en de persoonsgegevens van de ingevoerde persoon of gezinsleden op te vragen bij KSZin een KSZ register te wijzigen.

Wijzigingshistoriek

DatumAanpassingen

 

Eerste versie van de handleiding

Situering

Deze dienst kadert binnen het domein Persoon van het MAGDA platform.

Verwante diensten

Om deze webservice te kunnen gebruiken moet er eerst een inschrijving in het MAGDA inschrijvingsrepertorium voor personen aangemaakt worden. Deze inschrijvingen kunnen toegevoegd, aangepast en verwijderd worden via de webservices Repertorium.RegistreerInschrijving en Repertorium.RegistreerUitschrijving.

Na het ontvangen van de gezinssamenstelling kan indien gewenst de volledige informatie van een individueel gezinslid opgevraagd worden via de Om een nieuwe persoon te registeren in de KSZ registers kan de dienst CreeerBis 02.02 worden gebruikt. of /wiki/spaces/MDI/pages/174030851 of /wiki/spaces/MDI/pages/1006668903 dienst

Gegevensbronnen

De authentieke bron van de gegevens is KSZ/RAD dat achterliggend ook het Rijksregister gebruikt.

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

Note
titleOpmerking:

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

Gebruiksvoorwaarden

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

  • Toelating tot het MAGDA platform
  • Machtiging van het sectoraal comité van de Sociale Zekerheid


Info
titleInformatie:

Meer informatie over deze voorwaarden is terug te vinden op de pagina “Machtigingen en toelatingen”.


Batch

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

Prefix
Persoon.GeefGezinssamenstellingWijzigKSZPersoon-02_02
Voorbeeld

Persoon.GeefGezinssamenstellingWijzigKSZPersoon-02_02_20131103115553530

Functionaliteiten

De webservice GeefGezinssamenstelling WijzigKSZPersoon 2.02 laat de afnemer van het MAGDA platform toe om de gezinssamenstelling persoonsgegevens van een persoon op te vragen bij in de KSZ registers te wijzigen. Deze bevraging wijziging gebeurt op basis van een INSZ-nummer, aangevuld met de gegevens van de persoon

Eens de afnemer de request gelanceerd heeft wordt de vraag doorgestuurd naar de KSZ. KSZ voert de wijziging uit en retourneert daarna de huidige staat van de persoonsgegevens, inclusief een status met informatie of de wijziging al dan niet gelukt is. Deze status wordt doorgegeven op het niveau van individuele gegevensblokken. MAGDA ontvangt het antwoord en transformeert dit naar een lijst van één of meerdere gezinsledenAntwoord voor de afnemer. Afhankelijk van de verkregen machtigingen worden bepaalde gegevens al dan niet gefilterd. De lijst van gezinsleden kan maximaal 250 afzodnerlijke gezinsleden bevatten.

In de v3 service van KSZ kon gekozen worden om naast de gegevens omtrent de gezinssamenstelling ook de persoonsgegevens van elk gezinslid op te vragen. De v4 service upgrade biedt deze mogelijk niet meer. KSZ retourneert altijd een (beperkte) set persoonsgegevens.

Naast de relationele gegevens van een Gezinslid (de Positie in het gezin en de Woonvorm), bevat het antwoord ook voor ieder Gezinslid bovengenoemde beperkte set persoonsgegevens. Onderstaande tabel geeft een overzicht van deze (potentieel) beschikbare persoonsgegevens:

Gezinslid persoonsgegeven

INSZ

NaamGeslachtGeboortedatum

 


Te wijzigen persoonsgegeven

Naam
Nationaliteiten
Geboorte
Overlijden
Geslacht
Burgerlijke staten

Adres - Hoofdverblijfplaats

Adres - Contactadres

Dossierstatus - Beheerder
Dossierstatus - Status


Werking

Opties

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

  • Configuratieparameters op het MAGDA platform zijn voor deze dienst niet van toepassing

Anchor
opvraging
opvraging
Opvraging

Van zodra de vraag gesteld is wordt er een XSD-validatie uitgevoerd. Is de ontvangen vraag XML niet geldig tegenover het schema, dan stopt de verwerking en wordt een foutmelding aangemaakt, anders gaat de verwerking verder. Na de XSD-validatie vinden de nodige authenticatie- en autorisatiecontroles plaats.
Hierna vindt er een functionele validatie plaats van de vraag. Nadien zal de webservice achterliggend de FamilyCompositionCbssPerson.searchFamilyCompositionBySsin searchPersonBySsin operatie van KSZ oproepen. MAGDA doet dit om de huidige gegevens van de persoon op te vragen (KSZ vereist zowel een set huidige gegevens als een set gewijzigde gegevens voor de wijziging).

Als blijkt dat de persoon in kwestie van INSZ is veranderd, dan stopt de verwerking hier al, en zal MAGDA geen wijzigingsverzoek aan KSZ sturen middels de CbssPerson.updatePerson operatie van KSZ. Het is dan aan de afnemer om eerst zijn lokale registers up to date te brengen, alvorens de wijzigingsvraag opnieuw te sturen (ditmaal met het nieuwe INSZ nummer).

Wanneer MAGDA succesvol de huidige gegevens van een persoon heeft kunnen bekomen, dan volgt een wijzigingsverzoek naar KSZ met de gewijzigde gegevens zoals doorgegeven door de afnemer.

Ontvangt de webservice een antwoord – hetzij de nieuwe persoonsgegevens, hetzij een foutcode – wordt dit gevalideerd en omgezet in een MAGDA XML formaat. Het antwoord wordt nogmaals gevalideerd waarna het aan de afnemer ter beschikking gesteld wordt.

Responsetijden & Beschikbaarheid


Note
titleOpmerking:

De MAGDA response tijden zijn heel sterk afhankelijk van de response tijden van de bron. Als de brongegevens heel traag worden aangeleverd kan het MAGDA antwoord niet snel worden aangeleverd. 


Logging

De opvragingen die gebeuren via deze webservice worden bewaard zoals beschreven op de pagina Logging diensten.



Op deze pagina

Table of Contents
maxLevel2

Binnen deze handleiding

Page Tree
root@self

Omgevingsinformatie

Functioneel DomeinPersoon
ClassificatieGevoelige persoonsgegevens