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
Detail
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. | ||
| BasisPersoonsgegevens | Opvraging van de basisgegevens van de persoon Mogelijke waarden:
| ||
| Afstamming | Opvragen van afstammingsgegevens in stijgende lijn Mogelijke waarden:
| ||
| AfstammingDalendeLijn | Opvragen van afstammingsgegevens in dalende lijn Mogelijke waarden:
| ||
| Identiteitsbewijs | Opvragen van identiteitsbewijs Mogelijke waarden:
| ||
| Beroepskaart | Opvragen van beroepskaart Mogelijke waarden:
| ||
| Arbeidskaart | Opvragen van arbeidskaart Mogelijke waarden:
| ||
| WettigVerblijf | Opvragen van informatie i.v.m. wettig verblijf Mogelijke waarden:
| ||
| AdministratieveToestand | Opvragen van de administratieve toestand van de persoon die opgenomen is in het wachtregister. Mogelijke waarden:
| ||
| PlaastInschrijving | Opvragen van de verplichte plaats van inschrijving – O.C.M.W. waarvan de betrokken vreemdeling afhangt. Mogelijke waarden:
| ||
| Bron | Enkel “RR” of “KSZ” mogelijk als bron. Indien er een andere bron opgegeven wordt, bekomt men een XSD validatie fout (SOAP Fault). 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. | ||
Opmerkingen
Bij het gebruik van KSZ als bron moet er minsten 1 element 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.
Validaties op vraag
| Element | Omschrijving van de validatie | Mogelijke Foutcodes |
|---|---|---|
| Criteria/INSZ | Checksum 97 | 20002 |
| Bron | Enkel "RR" of "KSZ" zijn toegelaten | 50000 |
| Taal | Enkel "nl" is toegelaten | 25001 |
Voorbeeld
<!-- Dit data voorbeeld is gepseudonimiseerd, alle overeenkomsten met werkelijke data berusten puur op toeval -->
<Vraag>
<Referte>120fdaff-538f-4ca1-afba-b96dbce5cb58</Referte>
<Inhoud>
<Criteria>
<INSZ>01234567894</INSZ>
</Criteria>
<Bron>RR</Bron>
<Taal>nl</Taal>
</Inhoud>
</Vraag>
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 dat opgevraagd. Zie tweede voorbeeld hieronder. Op deze manier kan de hoeveelheid data die opgevraagd wordt geminimaliseerd worden en beter afgestemd op de gebruikersinterface.
<!-- Dit data voorbeeld is gepseudonimiseerd, alle overeenkomsten met werkelijke data berusten puur op toeval -->
<Vraag>
<Referte>120fdaff-538f-4ca1-afba-b96dbce5cb58</Referte>
<Inhoud>
<Criteria>
<INSZ>01234567894</INSZ>
<OpvragingenKSZ>
<BasisPersoonsgegevens>1</BasisPersoonsgegevens>
</OpvragingenKSZ>
</Criteria>
<Bron>KSZ</Bron>
<Taal>nl</Taal>
</Inhoud>
</Vraag>
<!-- Dit data voorbeeld is gepseudonimiseerd, alle overeenkomsten met werkelijke data berusten puur op toeval -->
<Vraag>
<Referte>120fdaff-538f-4ca1-afba-b96dbce5cb58</Referte>
<Inhoud>
<Criteria>
<INSZ>01234567894</INSZ>
<OpvragingenKSZ>
<AfstammingDalendeLijn>1</AfstammingDalendeLijn>
<Identiteitsbewijs>1</Identiteitsbewijs>
</OpvragingenKSZ>
</Criteria>
<Bron>KSZ</Bron>
<Taal>nl</Taal>
</Inhoud>
</Vraag>
Op deze pagina
Binnen deze handleiding
