Document toolboxDocument toolbox


DIGITAAL VLAANDEREN

Persoon.ZoekPersoonOpAdres-02.00

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

Dit document beschrijft het gebruik en de werking van de webservice ZoekPersoonOpAdres 2.0 zoals deze door Digitaal Vlaanderen op het MAGDA platform aangeboden wordt.

De webservice is in staat personen op te vragen bij het Rijksregister als bij/via KSZ.

Gegevensbronnen

De authentieke bron van de gegevens is het Rijksregister ook al wordt de zoekopdracht door de KSZ uitgevoerd.

Voor meer informatie met betrekking tot de inhoud van de persoonsgegevens wordt verwezen naar de Rijksregister onderrichtingen terug te vinden via volgende URL: http://www.ibz.rrn.fgov.be/index.php?id=2485&L=1

Voor wat KSZ betreft kunnen de gegevens opgevraagd worden via twee gelijkaardige diensten:

  • De SSDN-dienst (zolang deze nog ter beschikking blijft).

  • Hun nieuwe SOA-dienst.

Functioneel zijn er tussen beide diensten twee verschillen:

  • Bij de SOA-dienst van KSZ kan er binnen burgerlijke staat, in plaats van een INSZ, een partner referentie terugkomen ter identificatie van de partner.

Het antwoord van de SOA-dienst bevat 0 tot maximaal 3000 personen, waarbij het aantal resultaten uit  het Rijksregister beperkt is tot 2500. Voor de eerste 25 resultaten worden de persoonsgegevens meegegeven, voor de volgende resultaten wordt enkel het INSZ gegeven. Indien er minder dan 25 resultaten zijn, worden alle persoonsgegevens teruggegeven.

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 webservice 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

Meer informatie over deze voorwaarden is terug te vinden in het document “Machtigingen en toelatingen” [MT].

Informatie:

Meer informatie over deze voorwaarden is terug te vinden op de pagina “Machtigingen en toelatingen”.

Batch

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

Prefix

Persoon.ZoekPersoonOpAdres-02.00

Voorbeeld

Persoon.ZoekPersoonOpAdres-02.00_20131103115553530

Functionaliteiten

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

  • Gemeente postcode

  • Straatcode (Op dit moment enkel Rijksregisterstraatcode)

  • Huisnummer

  • Busnummer

KSZ stelt deze opzoeking op 2 verschillende manieren ter beschikking: op de SSDN en op de SOA omgeving. In dit document wordt met de term KSZ de beide manieren aangeduid, tenzij anders vermeld.

Het is mogelijk in de vraag naar het Rijksregister op te geven of men enkel de referentiepersonen (gezinshoofden) in het antwoord wenst of ook al de personen op het opgegeven adres. Deze optie wordt niet ondersteund wanneer de vraag aan de KSZ wordt gericht.

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.

De zoekopdracht vindt enkel personen die hun huidige hoofdverblijfplaats in België hebben en die ingeschreven zijn in het Rijksregister.

Indien er gezocht wordt bij het Rijksregister en er groot aantal personen gevonden zijn voor het opgegeven adres verkrijgt men de melding dat een bijkomende oproep noodzakelijk is om de volgende personen op te halen.

Onderstaande tabel geeft een overzicht van de in de ZoekPersoonOpAdres 2.0 beschikbare persoonsgegevens en hun relatie met de informatietypes van het Rijksregister. In onderstaande tabel is opgenomen wat bij welke bron beschikbaar is.

Persoonsgegeven

Rijksregister Informatietype

KSZ beschikbaarheid

INSZ

000

J

Naam

010

J

Geslacht

000

J

Register

-

J

Geboorte(datum)

000

J

Adres - Hoofdverblijfplaats

020

J

Adres – Referentieadres (binnen Hoofdverblijfplaats)

024

N

Overlijden

-

J

BurgerlijkeStaat

-

J

Nationaliteit

-

J

De overige gegevens die in een Persoon bevat zitten komen niet terug in deze webservice, al zijn ze wel opgenomen in de XSD.

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 drie 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 (bijvoorbeeld: is er een postcode opgeven in combinatie met de RRStraatcode). Nadien zal de webservice achterliggend transactie 36 bij het Rijksregister of de IdentifyPerson service of de NRPersonService (searchPersonByAddress) 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.

Responsetijden & Beschikbaarheid

De webservice op het MAGDA platform is 24 uur op 24 en 7 dagen op 7 beschikbaar. De beschikbaarheid van de gegevens is echter volledig afhankelijk van Rijksregister en/of de KSZ die in principe 24/7 beschikbaar zijn.

Bij geplande onbeschikbaarheden van het Rijksregister of de KSZ worden de afnemers op de hoogte gebracht via mail. Bij een onverwachte onbeschikbaarheid wordt in het mate van het mogelijk een mail uitgestuurd (dit is als Digitaal Vlaanderen zelf op de hoogte gebracht wordt door Rijksregister of de KSZ).

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