De dienst ‘GeefGezinssamenstelling 2.0’ biedt de afnemer de mogelijkheid de gezinssamenstelling van een persoon en de persoonsgegevens van de ingevoerde persoon of gezinsleden op te vragen bij KSZ.
Wijzigingshistoriek
| Datum | Aanpassingen |
|---|
| Importeren van de handleiding in Confluence |
Situering
Deze webdienst kadert binnen het domein Persoon van het MAGDA platform.
Gegevensbronnen
De authentieke bron van de gegevens is de KSZ.
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
- Machtiging van het sectoraal comité van het Rijksregister
- EN/OF Machtiging van het sectoraal comité van de Sociale Zekerheid
Batch
Deze webservice is eveneens beschikbaar in een batch-variant (enkel XML). Voor meer informatie: Webservice In Batch bevragen.
| Prefix | GGSD |
|---|
| Voorbeeld | GGSD_20131103115553530.xml |
|---|
Functionaliteiten
Vraag
De request bestaat uit het INSZ van de persoon waarvan men de gezinssamenstelling wenst op te vragen. Er kan gekozen worden om een beperkte of uitgebreide set van gegevens rond de gezinsleden terug te krijgen in het antwoord.
Antwoord
Het antwoord bevat:
- De gegevens van de opgevraagde persoon
- De gegevens van de gezinssleden van die persoon.
Werking
Opties
Volgende configuratieparameters kunnen 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
De afnemer start met in de vraag het INSZ van de persoon in te geven waarvan hij de gezinssamenstelling wil opzoeken, eventueel met de wens om al dan niet uitgebreide persoonsgegevens te ontvangen in het antwoord.
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 en wordt op het INSZ de checksum 97-validatie uitgevoerd.
Indien deze validatie slaagt dan wordt de vraag omgezet naar een KSZ ‘searchFamilyCompositionBySsin’-vraag.
Indien er een persoon gevonden wordt zal deze persoon en zijn eventuele gezinsleden (tot maximum 50) teruggegeven worden door KSZ.
Dit antwoord van KSZ wordt vervolgens gemapt naar een MAGDA-antwoord.
Dit MAGDA-antwoord wordt gevalideerd tegenover de xsd waarna het aan de afnemer ter beschikking gesteld wordt.
Responsetijden & Beschikbaarheid
De webservice op het MAGDA platform is 24 uur op 24 en 7 dagen op 7 beschikbaar. Bij geplande onbeschikbaarheden worden de afnemers op de hoogte gebracht via mail.
Logging
De opvragingen die gebeuren via deze webservice worden bewaard zoals beschreven op de pagina "MAGDA logging".
