Persoon.GeefPersoon-02.02
Informatie:
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.
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.
Gegevensbronnen
De authentieke bron van de gegevens is het Rijksregister of de KSZ.
De basis-oproep naar KSZ geeft slechts een beperkte set persoonsgegevens. Voor bijkomende informatie rond afstammingen (stijgende of dalende lijn), de status in geval van een buitenlander (beroepskaart, arbeidskaart of wettig verblijf), het identiteitsbewijs of informatie uit het wachtregister (administratieve toestand of plaats van inschrijving) zijn extra opvragingen nodig.
De oproep naar het Rijksregister geeft onmiddellijk al deze informatie, indien van toepassing voor de gevraagde persoon.
Voor meer informatie met betrekking tot de inhoud van de persoonsgegevens wordt verwezen naar onderrichtingen van het Rijksregister terug te vinden via volgende URLs:
http://www.ibz.rrn.fgov.be/nl/rijksregister/reglementering/onderrichtingen/
Lijst van de informatietypes - Rijksregister - Algemene Directie Identiteit en Burgerzaken (detailinformatie)
Voor de KSZ wordt verwezen naar de documenten beschikbaar op hun website:
https://www.ksz-bcss.fgov.be/nl/documentation/webservices-soap/personservice
https://www.ksz-bcss.fgov.be/nl/documentation/webservices-soap/filiationservice
https://www.ksz-bcss.fgov.be/nl/documentation/webservices-soap/foreignersituationservice
https://www.ksz-bcss.fgov.be/nl/documentation/webservices-soap/identitydocumentservice
https://www.ksz-bcss.fgov.be/nl/documentation/webservices-soap/waitingregisterservice
Meer informatie over hoe deze bronnen gebruikt worden in de opbouw van het antwoord vindt u onder Opvraging.
Opmerking:
Agentschap Digitaal 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
Informatie:
Meer informatie over deze voorwaarden is terug te vinden op de pagina “Machtigingen en toelatingen”.
Meer informatie over het aansluitingsproces is terug te vinden op deze webpagina.
Batch
Deze webservice is eveneens beschikbaar in een batch-variant (enkel XML). Voor meer informatie: Webservice In Batch bevragen.
Prefix | persoon.geefpersoon-0202 |
---|---|
Voorbeeld | persoon.geefpersoon-0202_20131103115553530.xml |
Functionaliteiten
De webservice GeefPersoon-02.02 laat de afnemer van het MAGDA-platform toe de actuele gegevens van een persoon op te halen, dit op basis van het INSZ-nummer van deze persoon.
Eens de afnemer de request gelanceerd heeft, wordt de vraag doorgestuurd naar het Rijksregister of de Kruispuntbank van de Sociale Zekerheid (KSZ). Dit is afhankelijk van de machtigingen van de afnemer en de bronkeuze in de vraag. Deze bronkeuze wordt nader besproken verder op deze pagina.
MAGDA ontvangt het antwoord en transformeert dit naar een Persoon-element. Een overzicht van de persoonsgegevens die beschikbaar zijn in de GeefPersoon-02.02 dienst, is terug te vinden binnen de beschrijving van het antwoord (sub-pagina).
Werking
Opties
Volgende configuratieparameters kunnen ingesteld worden in functie van de machtigingen en de wensen van de afnemer:
Op te roepen bron: tot twee bronnen kunnen geconfigureerd worden.
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, bijvoorbeeld de inschrijvingscontrole.
Hierna vindt er een functionele validatie plaats van de vraag (bijvoorbeeld checksum 97 op het INSZ). Nadien zal de webservice achterliggend transactie 25 bij het Rijksregister of de PersonService van KSZ oproepen. 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".
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
Domein | Persoon |
---|---|
Classificatie | Persoonsgegevens |
Voor vragen of opmerkingen kan u de MAGDA helpdesk contacteren
De MAGDA Gebruikersomgeving is een officiële website van de Vlaamse overheid
uitgegeven door Digitaal Vlaanderen