Beschrijving Antwoord (ZoekPersoonOpAdres-02.00)
Algemeen
Het antwoord bestaat uit één of meerdere Persoon-elementen binnen het Personen-element en/of één of meerdere Uitzonderingen. Het is mogelijk dat, ook al komen er personen terug, het antwoord één of meerdere Uitzonderingen bevat. Afhankelijk van de verkregen machtiging zullen bepaalde gegevens niet in het antwoord opgenomen worden.
Het maximaal aantal personen dat van het Rijksregister kan terugkomen in het antwoord is 20. Indien de ondervraging meer dan 20 dossiers selecteert zal het antwoord een uitzondering bevatten. In tegenstelling tot de ZoekPersoonOpNaam 2.0 komen er wel personen in het antwoord terug indien de zoekopdracht meer dan 20 personen oplevert. Wenst men de overige personen dan zal een nieuwe vraag gesteld moeten worden met dezelfde parameters maar met een volgend paginanummer (zie Vraag – Belangrijke opmerkingen). De KSZ stelt geen limieten aan het aantal teruggestuurde resultaten.
XSD Visueel
Hierna zijn alle elementen in de XSD van de Persoon gevisualiseerd. De webservice ZoekPersoonOpAdres 2.0 zal echter enkel volgende elementen bevatten: INSZ, Naam, Geslacht, Geboorte(datum), Hoofdadres en Referentieadres.
Detail
In dit overzicht wordt enkel die elementen besproken die in het antwoord terug kunnen komen.
Opmerking:
Het antwoord bestaat standaard uit Context, Referte en Antwoord zoals beschreven in het document Gebruik Magda Webservices 02.00. Verder zal enkel aandacht besteed worden aan het specifieke Antwoord element.
Antwoord in detail
Element | Cardinaliteit | Extra |
---|---|---|
INSZ | Verplicht | Bevat het INSZ van de gevonden persoon. |
Naam | Optioneel | De verschillende voor- en achternamen van de persoon. Tot 15 achternamen en 14 voornamen mogelijk. De aanduiding GebruikelijkeVoornaam kan terugkomen. |
Geslacht | Optioneel | Het geslacht van de persoon: 1 = mannelijk, 2 = vrouwelijk of 0 = niet gekend (deze laatste enkel via KSZ) |
Geboorte | Optioneel | De geboortedatum van de persoon |
Adressen | Optioneel | De verschillende types van adressen van de persoon: - Hoofdverblijfplaats met referentieadres aanduiding |
BurgerlijkeStaten | Optioneel | Burgerlijke staat gegevens van de opgevraagde persoon. Hier enkel mogelijk via KSZ en geen meerdere burgerlijke staten mogelijk. |
Register | Optioneel | Het register waarin de persoon is ingeschreven (bevolkingsregister, wachtregister, …) |
Nationaliteiten | Optioneel | De nationaliteiten van de persoon. Hier enkel mogelijk via KSZ en geen meerdere nationaliteiten mogelijk. |
Overlijden | Optioneel | De datum en plaats van overlijden. Hier enkel mogelijk via KSZ |
Voorbeeld
Dit voorbeeld is handmatig samengesteld
Opmerkingen
Gegevens via de KSZ of het Rijksregister
Zoals in de tabel hierboven onder ‘2.2 Functionaliteiten’ aangegeven, kan er een verschil zijn tussen eenzelfde persoon die via het Rijksregister of via de KSZ wordt opgevraagd. De aanduiding van een referentieadres zal bij een opvraging via KSZ niet gegeven worden.
Als voor de bron in de vraag KSZ gekozen wordt of als KSZ voor deze dienst geconfigureerd is als bron, dan worden de namen volledig in hoofdletters aangeleverd. Dit is niet het geval wanneer de bron RR of SOA is.
Begin- en einddatum
De verschillende segmenten binnen de Persoon hebben allen een Begin-en Einddatum als attribuut.
Deze twee datums zijn toegevoegd om rekening te houden met eventuele historische opvragingen via de GeefHistoriekPersoon 2.0. De datums worden van de bron overgenomen. Veelal zal de DatumBegin overeenkomen met de datum waarop het feit/gebeurtenis, geboortedatum, plaatsvond… . DatumEinde is de datum waarop het feit/gebeurtenis gesupprimeerd wordt. Bvb wanneer het postadres in het buitenland niet langer van toepassing is.
De datums worden van de bron overgenomen. Bij personen opgevraagd via de KSZ worden door de KSZ bij de elementen geen specifieke begin- of einddatums gegeven maar enkel een datum van de laatste wijziging. Dit wordt door de dienst teruggeven als de DatumBegin.
Zowel DatumBegin als DatumEinde hebben als formaat jjjj-mm-dd en kunnen onvolledig zijn. Met onvolledig wordt bedoeld: jjjj-mm-00 of jjjj-00-00 of 0000-00-00.
Opmerking: DatumEinde komt in deze webservice nooit terug in het antwoord
Voornamen
Zoals in het overzicht hierboven vermeld kunnen er maximaal tot 14 voornamen terugkomen. Hier is een belangrijk verschil aan te merken over hoe de KSZ SSDN-dienst met deze namen omgaat en welk effect dit heeft op hoe de voornamen van de persoon worden teruggeven:
Dit is een typisch voorbeeld van iemand met drie voornamen uit het Rijksregister:
Dezelfde persoon opgevraagd via KSZ SSDN-dienst zal echter zo worden weergegeven:
De KSZ SSDN-dienst geeft m.a.w. tot twee voornamen terug in één element wanneer de persoon uit het Rijksregister afkomstig is. De derde voornaam valt dus weg.
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