Versions Compared

Old Version 16

changes.mady.by.user Bart Olaerts

Saved on

compared with

New Version Current

changes.mady.by.user Thomas De Langhe

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Algemeen

Om deze dienst te bevragen dient de afnemer te beschikken over het INSZ-nummer van de persoon waarvoor gegevens moeten opgevraagd worden.

XSD Visueel

Image Removedimage-20240108-092649.pngImage Added

Detail

BasisPersoonsgegevens

Opvraging van de basisgegevens van de persoon

Mogelijke waarden:

  • 0: opvraging niet uitvoeren
  • 1: opvraging uitvoeren

MAGDA

Vraag/Inhoud/

Opmerkingen

Criteria



INSZ

Hierop zal er een checksum 97 validatie plaatsvinden. Indien het nummer niet voldoet aan deze validatie zal er een uitzondering aangemaakt worden.

OpvragingenKSZ

Enkel van toepassing voor bron "KSZ". Minstens 1 selectie moet gemaakt worden.

Bij gebruik van "RR" als bron worden deze waarden genegeerd.


BasisPersoonsgegevens

Deze parameter moet steeds op 1 staan daar de mapping van het INSZ onderdeel uitmaakt van dit deel en INSZ een verplicht element is.

Afstamming

Opvragen van afstammingsgegevens in stijgende lijn

Mogelijke waarden:

  • 0: opvraging niet uitvoeren

  • 1: opvraging uitvoeren

AfstammingDalendeLijn

Opvragen van afstammingsgegevens in dalende lijn

Mogelijke waarden:

  • 0: opvraging niet uitvoeren

  • 1: opvraging uitvoeren

Identiteitsbewijs

Opvragen van identiteitsbewijs

Mogelijke waarden:

  • 0: opvraging niet uitvoeren

  • 1: opvraging uitvoeren

Beroepskaart

Opvragen van beroepskaart

Mogelijke waarden:

  • 0: opvraging niet uitvoeren

  • 1: opvraging uitvoeren

Arbeidskaart

Opvragen van arbeidskaart

Mogelijke waarden:

  • 0: opvraging niet uitvoeren

  • 1: opvraging uitvoeren

WettigVerblijf

Opvragen van informatie i.v.m. wettig verblijf

Mogelijke waarden:

  • 0: opvraging niet uitvoeren

  • 1: opvraging uitvoeren

AdministratieveToestand

Opvragen van de administratieve toestand van de persoon die opgenomen is in het wachtregister.

Mogelijke waarden:

  • 0: opvraging niet uitvoeren

  • 1: opvraging uitvoeren

PlaastInschrijving

Opvragen van de verplichte plaats van inschrijving – O.C.M.W. waarvan de betrokken vreemdeling afhangt.

Mogelijke waarden:

  • 0: opvraging niet uitvoeren

  • 1: opvraging uitvoeren

WettelijkeVertegenwoordiging

Opvragen van de wettelijke vertegenwoordiging van de persoon.

Mogelijke waarden:

  • 0: opvraging niet uitvoeren

  • 1: opvraging uitvoeren

Bron

Enkel “RR” of “KSZ” mogelijk als bron. Indien er een andere bron opgegeven wordt, bekomt men een XSD validatie fout (SOAP Fault).

Het element Bron is in tegenstelling tot later ontwikkelde 2.02 persoonsdiensten technisch niet verplicht, maar het wordt ten stelligste aanbevolen van dit toch expliciet mee te geven in het request.

(info) Indien geen bron wordt meegegeven in het request zal enkel de eerste bron volgens de configuratie opzet aangeroepen worden. Gewoonlijk zal dit de achterliggende KSZ dienst zijn om te vermijden dat er kosten worden aangerekend voor een request.

Een niet toegelaten bron of een niet geconfigureerde bron in het request geeft aanleiding tot een uitzondering, resp. uitzondering 99982 of 60018.

Er moet een Bron opgegeven worden. Geeft men een niet toegelaten bron op, dan bekomt men een uitzondering.

Taal

Toegelaten talen: nl (Nederlands), fr (Frans)

, de (Duits). Enkel “nl” zal in eerste instantie mogelijk zijn. Indien er een andere taal opgegeven wordt verkrijgt men een uitzondering

. Merk op dat Frans momenteel enkel ondersteund wordt voor de bron KSZ.

Opmerkingen

Bij het gebruik van KSZ als bron moet er minsten 1 minstens het element BasisPersoonGegevens in de OpvragingenKSZ blok worden aangevlagd. Dit betekent dat ook de basisgegevens van een persoon optioneel geworden zijn. De reden hiervoor is dat gebruikers eerst de basisgegevens van een persoon opvragen en pas daarna de details (vb. Gezinssamenstelling) opvragen. Bij die extra opvraging is het niet nodig om opnieuw de basisgegevens van de persoon door te geven, die zijn reeds opgevraagd. Daarom is het nu mogelijk om verdere details op te vragen zonder de basisgegevens.Indien "RR" als bron wordt gebruikt worden de parameters onder OpvragingenKSZ genegeerdDe andere elementen kunnen optioneel opgevraagd worden. Bij extra opvragingen is het niet nodig om telkens alle data op te vragen, maar buiten de BasisPersoonGegevens kunnen de andere gegevens geoptimaliseerd worden.

Validaties op vraag

Element

Omschrijving van de validatie

Mogelijke Foutcodes

Criteria/INSZ

Checksum 97

20002

Bron

Enkel "RR" of "KSZ" zijn toegelaten

50000

TaalEnkel "nl" is toegelaten25001

VoorbeeldVoorbeeld

Expand
titleVoorbeeld: vraag naar Rijksregister
Code Block
languagexml
<Vraag>
    <Referte>120fdaff-538f-4ca1-afba-b96dbce5cb58</Referte>
    <Inhoud>
        <Criteria>
            <INSZ>01234567894</INSZ>
        </Criteria>
		<Bron>RR</Bron>
		<Taal>nl</Taal>
    </Inhoud>
</Vraag>

Dit data voorbeeld is gepseudonimiseerd, alle overeenkomsten met werkelijke data berusten puur op toeval.

Bij het gebruik van KSZ als bron kan eerst de basisgegevens van de persoon opgevraagd worden. In tweede instantie wordt dan voor deze persoon extra data opgevraagd. Zie tweede voorbeeld hieronder. Op deze manier kan de hoeveelheid data die opgevraagd wordt geminimaliseerd worden en beter afgestemd op de gebruikersinterface.

linenumberstruexml
Expand
titleVoorbeeld: vraag basisgegevens naar RijksregisterKSZ
Code Block
language
language
xml

<Vraag>
    <Referte>120fdaff-538f-4ca1-afba-b96dbce5cb58</Referte>
    <Inhoud>
        <Criteria>
<INSZ>00000000100<
<INSZ>01234567894</INSZ>
			<OpvragingenKSZ>
				<BasisPersoonsgegevens>1</BasisPersoonsgegevens>
            </OpvragingenKSZ>
        </Criteria>
<Bron>RR<
<Bron>KSZ</Bron>
		<Taal>nl</Taal>
    </Inhoud>
</Vraag>
Code Block

Dit data voorbeeld is gepseudonimiseerd, alle overeenkomsten met werkelijke data berusten puur op toeval.

true
Expand
linenumbers
titleVoorbeeld: vraag extra gegevens naar KSZ
Code Block
language
xml
<Vraag>
    <Referte>120fdaff-538f-4ca1-afba-b96dbce5cb58</Referte>
    <Inhoud>
        <Criteria>
<INSZ>00000000100<
<INSZ>01234567894</INSZ>
<ExtraOpvragingen>
<OpvragingenKSZ>
				<BasisPersoonsgegevens>1</BasisPersoonsgegevens>
				<AfstammingDalendeLijn>1</AfstammingDalendeLijn>
                <Identiteitsbewijs>1</Identiteitsbewijs>
            </
ExtraOpvragingen>
OpvragingenKSZ>
        </Criteria>
		<Bron>KSZ</Bron>
		<Taal>nl</Taal>
    </Inhoud>
</Vraag>

Dit data voorbeeld is gepseudonimiseerd, alle overeenkomsten met werkelijke data berusten puur op toeval.

Op deze pagina

Table of Contents
maxLevel2
minLevel1

Binnen deze handleiding

Page Treeroot@parent

Child pages (Children Display)
pagePersoon.GeefPersoon-02.02
Info

Met vragen kunt u steeds terecht bij de MAGDA Service Desk.