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 historiek van de gezinssamenstelling kan, indien gewenst, de volledige informatie van een individueel gezinslid opgevraagd worden via de GeefPersoon 02.00 of GeefPersoon 02.02-dienst.

Indien alleen de huidige gezinssamenstelling van een persoon gewenst is, kan hiervoor de dienst Persoon.GeefGezinssamenstelling-02.00 of Persoon.GeefGezinssamenstelling-02.02 gebruikt worden.

Gegevensbronnen

De authentieke bron van de gegevens zijn de KSZ  voor de RAD/RAN registers of achterliggend wordt ook het Rijksregister gebruikt.

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 dienst te mogen gebruiken:

• toelating tot het MAGDA-platform

• juridische toegang tot persoonsgegevens en hun historiek

Batch

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

Functionaliteiten

De webservice GeefHistoriekGezinssamenstelling-02.02 laat de afnemer van het MAGDA-platform toe om de historiek van de gezinssamenstelling van een persoon op te vragen bij de KSZ. Deze bevraging gebeurt op basis van een INSZ-nummer en een Datum. 

Deze Datum stuurt de manier waarop de historiek wordt samengesteld. Er zijn 2 varianten:

• Opvraging "Op": In deze variant wordt een "foto" genomen van een historische situatie op de gegeven Datum. Het antwoord bevat in dit geval één (of twee in sommige gevallen) Gezinssamenstelling(en).

• Opvraging "Vanaf": in deze variant wordt de historiek opgebouwd vanaf een zekere datum tot vandaag. Het antwoord kan in dit geval meerdere Gezinssamenstellingen bevatten. Gegevens die vóór de opgegeven datum vallen worden niet overgenomen. Zie ook datumfiltering hieronder

Eens de afnemer de request gelanceerd heeft, wordt de vraag doorgestuurd naar de KSZ. MAGDA ontvangt het antwoord en transformeert dit naar een lijst van één of meerdere Gezinssamenstellingen, die elk weer bestaan uit één of meerdere Gezinsleden. Afhankelijk van de verkregen machtigingen worden bepaalde gegevens al dan niet gefilterd. De lijst van gezinssamenstellingen kan maximaal 250 afzonderlijke gezinssamenstellingen bevatten; elke gezinssamenstelling kan opnieuw uit maximaal 250 afzonderlijke gezinsleden bestaan.

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

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:

Datumfiltering

Bij het gebruik van Datum “Op” bevraging zullen enkel de gegevens die actief zijn op de bevraagde datum worden doorgegeven.

Bij bevraging met Datum “vanaf” zijn volgende regels van toepassing

1. Elk gezinslid met een einddatum voor de bevraagde datum zal niet worden doorgegeven

2. Indien de persoon van de bevraagde INSZ verwijderd wordt door regel 1, zal de volledige gezinssamenstelling die verbonden is aan deze persoon weggehaald worden

3. Elke startdatum die kleiner is (verder in het veleden ligt) dan de bevraagde datum zal niet doorgegeven worden.

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

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 FamilyComposition.searchFamilyCompositionHistoryBySsin operatie (voor de "Op" variant) van de KSZ oproepen, of de FamilyComposition.searchFamilyCompositionBySsinAndDate operatie (voor de "Vanaf" variant). Ontvangt de webservice een antwoord – hetzij de 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.

Responstijden & Beschikbaarheid

Logging

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

Op deze pagina

Binnen deze handleiding

Omgevingsinformatie