Persoon.GeefHistoriekPersoon-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.
De Persoon.GeefHistoriekPersoon-02.02 is de opvolger van de Persoon.GeefHistoriekPersoon-02.00 webservice.
Deze webservice biedt een afnemer de mogelijkheid om historische persoonsgegevens op te vragen bij het Rijksregister of via de KSZ.
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.
Voor meer informatie met betrekking tot de inhoud van de persoonsgegevens wordt verwezen naar onderrichtingen van het Rijksregister terug te vinden via volgende URL:
http://www.ibz.rrn.fgov.be/nl/rijksregister/reglementering/onderrichtingen/
Voor de KSZ wordt verwezen naar de documenten beschikbaar op hun website:
https://www.ksz-bcss.fgov.be/nl/documentation/webservices-soap/personservice
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.geefhistoriekpersoon-0202 |
---|---|
Voorbeeld | persoon.geefhistoriekpersoon-0202_20190521115553530.xml |
Functionaliteiten
De GeefHistoriekPersoon 2.02 businessdienst maakt het mogelijk om persoonsgegevens die voldoen aan specifieke zoekcriteria te verkrijgen.
Vraag
De vraag bestaat uit volgende criteria:
een verplicht identificatienummer van de persoon
een verplichte datum met aanduiding
Op = "1" indien de gegevens op een bepaalde (historische) datum gewenst zijn
Op = "0" indien de gegevens vanaf een bepaalde (historische) datum gewenst zijn. Indien dit attribuut niet wordt ingevuld wordt de waarde = 0 verondersteld.
een verplichte aanduiding van de bron waar de afnemer de gegevens wenst te bevragen
een verplichte taal waarin de code omschrijvingen gewenst zijn. Enkel "nl" wordt op dit moment aanvaard.
Antwoord
Als antwoord verkrijgt de afnemer een overzicht van de historische persoonsgegevens in functie van de bron waar de gegevens gevonden werden.
Werking
Aandachtspunten
Opvragingen bij het Rijksregister worden doorgefactureerd aan de afnemer.
Om die reden is de bron een verplicht element geworden in de vraag.
Opties
Volgende configuratieparameters kunnen ingesteld worden in functie van de machtigingen en de wensen van de afnemer:
KSZ legal context op te zetten voor elke gebruiker (URI/HC)
Routering naar achterliggende bron dienst/operatie voor elke gebruiker (URI/HC) in functie van de machtiging
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.
Vervolgens gebeurt een functionele validatie van de vraag criteria:
het identificatie nummer van de persoon moet een geldig INSZ zijn
de datum waarop de gegevens worden opgevraagd moet kleiner dan of gelijk aan de systeemdatum zijn
enkel taal "nl" wordt ondersteund in deze dienst
Met de extra zoek parameters kan de afnemer - in functie van de verkregen machtiging - aangeven welke gegevens opgevraagd moeten worden:
historische gegevens op een bepaalde historische datum via de KSZ
historische gegevens vanaf een bepaalde historische datum via de KSZ
historische gegevens vanaf een bepaalde historische datum rechtstreeks bij Rijksregister
historische gegevens op een bepaalde historische datum rechtstreeks bij Rijksregister
Indien de afnemer niet over de juiste machtiging beschikt om de gespecificeerde informatie te verkrijgen, zal dit via foutmelding "60018 - De vraag is niet in overeenstemming met de machtiging of met de routeringsopzet" in het antwoord aangegeven worden.
Responsetijden & Beschikbaarheid
De webservice op het MAGDA platform is 24 uur op 24 en 7 dagen op 7 beschikbaar.
Logging
De opvragingen die gebeuren via deze webservice worden bewaard zoals beschreven op de pagina "MAGDA logging".
Ondersteunde talen
MAGDA ondersteunt enkel de Nederlandse taal voor deze dienst.
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 |
Related pages
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