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

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

Query parameter om de unieke identificatie van het License object gelinkt aan een nummerplaat mee te kunnen geven.

Deze identifier wordt als resultaat gegeven in bv de movementindications diensten.

Nee

Query

vin

Query parameter om het chassisnummer van het voertuig mee te kunnen geven.

Nee

Query

unifier

Uniek identificatienummer van de nummerplaat.

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

Nee

Query

certificateId

Query parameter om het unieke identificatienummer  van het certificaat mee te kunnen geven.

Nee

Query

nationalNr

Query parameter om het rijksregisternummer van een persoon mee te kunnen geven.

Nee

Query

companyNr

Query parameter om het ondernemingsnummer van een bedrijf mee te kunnen geven.

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

transactionUID

Query parameter om het uniek identificatienummer van een transactie mee te kunnen geven.

Nee

Query

pageSize

Query parameter om aan te geven hoeveel resultaten per pagina u wilt krijgen.

Nee

Query

after

Query parameter om aan te geven na welk element de resultaten in het antwoord opgenomen dienen te worden.

Nee

Query

addressEnrichmentPerson

Query parameter om aan te geven bij welke Bron de recente adresgegevens van de titularis, in geval van Natuurlijk persoon, opgehaald dienen te worden. Mogelijke waardes zijn "RR" (rijksregister) en "KSZ".

Indien geen verrijking noodzakelijk kan de parameter weggelaten worden

Nee

Query

addressEnrichmentOrganization

Query parameter om aan te geven bij of adres verrijking voor onderneming dient plaats te vinden.

Mogelijk parameter waarden zijn "True" of "False"

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