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

dateTimeFrom

Startdatum van de periode waarvoor u gegevens wilt opvragen

DIV dwingt af dat er met timestamps in ZERO offset gewerkt wordt (reg ex: [yyyy-MM-dd'T'HH:mm:ssZ, yyyy-MM-dd'T'HH:mm:ss.[0-9]{1,12}Z]

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

Ja

Query

dateTimeTo

Einddatum van de periode waarvoor u gegevens wilt opvragen

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 → dateTimeTo

Ja

Query

plateNr

Query parameter om de nummerplaat van het voertuig mee te kunnen geven.

De nummerplaat dient zonder spaties of leestekens te worden meegegeven (vb.: 1AAA123)

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

nationalNr

Het rijksregister of INSZ nummer van de persoon waarvoor de inschrijving gedaan is

Nee

Query

companyNr

Het KBO nummer waarvoor de inschrijving gedaan is

Nee

Query

pageSize

Het aantal items dat ni het antwoord mag opgenomen worden

Nee

Query

after

het eerste item in het antwoord

Nee

Query

unifier

Dit element mag enkel gebruikt worden in combinatie met de vin parameter

400 - Bad Request

alle elementen

Vraag moet minimaal 1 primaire parameter bevatten

400 - Bad Request