x-corrrelation-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

Header

X-Magda-Enduser-Id

Semantiek van dat veld: een referentie naar een END_USER.

Idee er achter: Indien er een probleem was met de afhandeling van een request die er kwam op vraag van een fysiek persoon en er iets mis gaat, kan er zo na de feiten (asynchroon) terug gekoppeld worden naar die persoon.

 Technisch gezien wordt er niets nagekeken.

Wat we wel vragen: Zet er zeker geen INSZ in, want dat zou inbreuken met zich mee kunnen brengen met privacy rulings.

Gebruik hem waar je een added value ziet voor uw toepassing.

Bvb. Indien de dienst geconsumed wordt door een proces, kan je er bvb een waarde in steken die dat proces identificeert.

Indien de dienst echt gebruikt wordt door een user die ergens gekend is in 1 van jullie applicaties, zou je er de ID van die user kunnen insteken (zodat enkel jullie die gebruiker kunnen terugvinden – indien nodig).

Ja

Header

plateNr

De nummerplaat van het voertuig

Nee

Query

plateUID

unieke identificator gelinkt aan de nummerplaat

Nee

Query

vin

Chassisnummer van het voertuig.

Nee

Query

unifier

Uniek identificatienummer van de nummerplaat.

Dit veld mag enkel in combinatie met de parameter "vin" gebruikt worden

Nee

Query

dateTime

Query parameter om de datum waarvoor u de situatie wilt kennen mee te geven.

Indien er geen datum tijd wordt meegegeven, dan wordt standaard de datum van vandaag en tijd van aanvraag als dateTime genomen. 

Het formaat moet een correcte date-time zijn volgens ISO-8601. Hierbij is een offset verplicht. Deze kan Z zijn voor Zulu of een tijd-offset.

vb1 : 2024-09-15T13:30:00+02:00
vb2 : 2024-09-15T11:30:00Z

Hou er rekening mee dat deze parameter correct URL encoded moet zijn. Het bovenstaand voorbeeld met de tijd-offset wordt dan 2024-09-15T13%3A30%3A00%2B02%3A00

OPGELET: de namen van parameters zijn case sensitive. Deze parameter gebruikt een hoofdletter T voor Time → dateTime

Nee

Query

addressEnrichmentPerson

Parameter voor ophalen actuele adresgegevens van natuurlijke personen.

Mogelijke waarden:

• RR

• KSZ

Indien de parameter niet aanwezig zal er geen actueel adres worden opgehaald.

Nee

Query

addressEnrichmentOrganisation

Parameter voor ophalen actuele adresgegevens van organisaties.

Mogelijke waarden:

• true

• false

Indien de parameter niet aanwezig zal er geen actueel adres worden opgehaald.

Nee

Query

unifier

Veld unifier mag enkel als vraag parameter meegegeven worden als ook de parameter vin wordt meegegeven.

400 - Bad Request

alle elementen

De vraag dient minimaal 1 primaire parameter (inclusief waarde) te bevatten

400 - Bad Request