DIGITAAL VLAANDEREN

Persoon.ZoekPersoonOpNaam-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. Via deze dienst kunnen lijsten van personen opgevraagd worden bij het Rijksregister of bij de KSZ.

Verwante diensten

Na het ontvangen van de lijst van personen kan de volledige informatie van een persoon opgevraagd worden via de GeefPersoon 02.00 of GeefPersoon 02.02 dienst

Gegevensbronnen

Zowel KSZ als Rijksregister kunnen geconsulteerd worden.

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:

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.ZoekPersoonOpNaam-02_02

Voorbeeld

Persoon.ZoekPersoonOpNaam-02_02_20131103115553530

Functionaliteiten

De webservice ZoekPersoonOpNaam-02.02 laat de afnemer van het MAGDA-platform toe personen op te zoeken in het Rijksregister of de KSZ, dit op basis van verschillende parameters:

  • Achternaam (zie paragraaf “belangrijke opmerkingen” voor de schrijfwijze van de achternaam en de voornamen).

  • Tot twee voornamen

  • Geboortedatum (eventueel met een tolerantie)

  • Geslacht

  • NIS-code van de gemeente van woonplaats

  • Het is mogelijk om enkel op achternaam te zoeken.

Eens de afnemer de request gelanceerd heeft, wordt de vraag doorgestuurd naar het Rijksregister of de KSZ. MAGDA ontvangt het antwoord en transformeert dit naar één of meerdere Persoon-elementen. Afhankelijk van de verkregen machtigingen worden bepaalde gegevens al dan niet gefilterd.

Onderstaande tabel geeft een overzicht van de in de ZoekPersoonOpNaam-02.02 beschikbare persoonsgegevens en hun relatie met de informatietypes van het Rijksregister.

Persoonsgegeven

Rijksregister Informatietype

Rijksregister beschikbaarheid

KSZ beschikbaarheid

INSZ

000

J

J

Beheerder

001

J

J

Register

210

N

J

Status

J

J

J

Naam

010

J

J

Geslacht

000

J

J

Geboorte(datum)

000

J

J

Overlijden

150

N

J (enkel een indicatie via een boolean)

Adres - Hoofdverblijfplaats

020

N

J

Adres - Verblijfplaats Buitenland

022

J

J

Adres - Postadres Buitenland



N

J

Adres - Aangifte Adreswijziging

019

J

J

Adres - Aangifte Adres Buitenland

018

J

J

Adres - Contactadres

N

N

J

Werking

Opties

Volgende configuratieparameters kunnen op het MAGDA-platform 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.
Hierna vindt er een functionele validatie plaats van de vraag. Nadien zal de webservice achterliggend transactie 40 bij het Rijksregister, de PersonService (searchPersonPhonetically) van de 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.

Responsetijden & Beschikbaarheid

Werking met betrekking tot de bronnen

In principe gebeurt de opzoeking bij de in de vraag gekozen bron; het Rijksregister of de KSZ SOA-dienst.

Afhankelijk van de machtigingen van de afnemer en in samenspraak met de afnemer is het echter mogelijk dat twee of zelfs drie bronnen toegankelijk zijn, waarbij één als primaire, één als secundaire en eventueel nog een derde als tertiaire bron voor de afnemer ingesteld is.

Indien er voor de afnemer meerdere bronnen geconfigureerd zijn, dan zal de dienst de opgegeven bronnen in volgorde bevragen tot één van hen resultaat geeft.

Echter, indien er een bron opgegeven wordt  in de vraag, dan geldt deze automatische doorschakeling niet, ook al is de bron in de vraag de primaire bron! 

Volgende stappen worden dus doorlopen:

  1. Is er een bron ingevuld in de vraag?

    1. Ja: enkel deze bron wordt geraadpleegd

    2. Neen: Zijn er resultaten bij gebruik van de primaire bron?

      1. Ja: Geen verdere bevragingen nodig

      2. Neen: Indien er een secundaire bron is, wordt deze geraadpleegd

Logging

De opvragingen, die gebeuren via deze webservice, worden bewaard zoals beschreven op de pagina "MAGDA logging".

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