Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Warning |
---|
Dit is een voorlopige gebruikershandleiding. De inhoud is onderhevig aan wijzigingen en correcties, zonder voorafgaande kennisgeving. |
Info | ||
---|---|---|
| ||
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. |
Excerpt | ||
---|---|---|
| ||
Deze dienst is een uitbreiding op de ZoekPersoonOpAdres 02.00 naar aanleiding van de KSZ v4 services upgrade. Het laat een gebruiker toe om persoon te zoeken bij KSZ of Rijksregister op basis van adresgegevens. Als resultaat wordt een lijst teruggegeven met basisgegevens van een persoon. Met deze basisgegevens kan dan de juiste persoon gezocht worden waarna op basis van het INSZ de volledige persoonsgegevens kunnen opgezocht worden met de /wiki/spaces/MDI/pages/1006668903 dienst. |
Wijzigingshistoriek
Datum | Aanpassingen |
---|---|
| Eerste versie van de handleiding |
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 op basis van adresgegevens.
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.
Na het ontvangen van de lijst van personen kan de volledige informatie van een persoon opgevraagd worden via de /wiki/spaces/MDI/pages/174030851 of /wiki/spaces/MDI/pages/1006668903 dienst.
Gegevensbronnen
Zowel de KSZ als het Rijksregister kunnen geconsulteerd worden.
Meer informatie over hoe deze bronnen gebruikt worden in de opbouw van het antwoord vindt u onder Opvraging.
Note | ||
---|---|---|
| ||
Agentschap Informatie 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
- Machtiging van het sectoraal comité van het Rijksregister en/of
- Machtiging van het sectoraal comité van de Sociale ZekerheidJuridische toegang voor persoonsgegevens
Info | ||
---|---|---|
| ||
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_02 |
---|---|
Voorbeeld | Persoon.ZoekPersoonOpAdres-02_02_20190103115553530. |
Functionaliteiten
De webservice ZoekPersoonOpAdres 2-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:
- Gemeente postcode
- Straatcode (Op dit moment enkel Rijksregisterstraatcode)
- Huisnummer
- Busnummer
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-02.02 beschikbare persoonsgegevens en hun relatie met de informatietypes van het Rijksregister.
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 | J |
Overlijden | - | J (enkel indicatie via een boolean) |
Beheerder | - | J |
Status | - | J |
Werking
Opties
Volgende configuratieparameters kunnen ingesteld worden in functie van de machtigingen juridische toegang en de wensen van de afnemer:
- Op te roepen bron: tot drie bronnen kunnen geconfigureerd worden
Anchor | ||||
---|---|---|---|---|
|
In principe gebeurt de opzoeking bij de in de vraag gekozen bron; het Rijksregister of de KSZ.
Afhankelijk van de machtigingen van juridische toegang tot persoonsgegevens voor de afnemer en in samenspraak met de afnemer is het echter mogelijk dat twee of zelfs drie bronnen toegankelijk zijn, waarvan éé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:
- Is er een bron ingevuld in de vraag?
- Ja: enkel deze bron wordt geraadpleegd
- Neen: Zijn er resultaten bij gebruik van de primaire bron?
- Ja: Geen verdere bevragingen nodig
- Neen ; : Indien er een secundaire bron is, wordt deze geraadpleegd
Responstijden & Beschikbaarheid
Note | ||
---|---|---|
| ||
De MAGDA response tijden -responstijden zijn heel sterk afhankelijk van de response tijden responstijden van de bron. Als de brongegevens heel traag worden aangeleverd, kan het MAGDA-antwoord niet snel worden aangeleverd. |
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
Table of Contents | ||
---|---|---|
|
Binnen deze handleiding
Page Tree | ||
---|---|---|
|
Omgevingsinformatie
Functioneel Domein | Persoon |
---|---|
Classificatie | Gevoelige persoonsgegevens |