DIGITAAL VLAANDEREN
Beschrijving Vraag (GET persons/officialDocumentReferences-v1)
- Bert Van Kets
- Bram Van Helleputte (Unlicensed)
- Pedro Devogelaere (Deactivated)
Algemeen
De GET persons/officialDocumentReferences-v1 vraag laat toe om referenties op te vragen van documenten die opgeslagen zijn in de Database van Akten Burgerlijke Stand.
Detail
Element | Opmerkingen | Verplicht |
|---|---|---|
x-correlation-id | Maakt deel uit van de header. Zie ook: Werking en overzicht uitzonderingen MAGDA RESTful services. Dit is het transactie ID, gebruikt voor logging en foutafhandeling. | Ja |
personNumber | INSZ van de persoon waarvoor akten worden opgezocht. Indien het ACM/IDM token gebruikt wordt bij het opvragen van het OAuth token dient de INSZ die gekoppel daan het ACM/IDM token overeen te komen met deze parameter | Ja |
language | De taal van de opgevraagde akte. Volgende taal keuzen zijn mogelijk:
Indien de taal niet opgegeven wordt, zullen de akten in de Nederlandse taal worden opgevraagd | Nee |
Validaties op vraag
Element | Omschrijving van de validatie | Mogelijke Foutcodes |
|---|---|---|
personNumber | De INSZ opgegeven in deze parameter moet voldoen aan de checksum97 validatie. | Status : 400 “Bad Request” Detail : INSZ in the query parameters has an invalid structure |
personNumber | Indien de INSZ ook meegegeven wordt in het OAuth token, door extentie van dat token met het ACM/IDM token, zal het opgegeven INSZ vergeleken worden met de waarde in de personNumber parameter. | Status : 400 “Bad Request” Detail : personNumber parameter does not match the ACM/IDM token |
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