Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Algemeen
Via deze dienst kunnen voertuig, nummerplaat en titularis gegevens worden opgehaald.
Optioneel kan deze dienst ook het actuele adres van de titularis terug geven.
Detail
| Element | Opmerkingen | Primaire parameter | Verplicht | Parameter Type |
|---|---|---|---|---|
| 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. | Nee | 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) | Ja | 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. | Ja | Nee | Query |
| vin | Query parameter om het chassisnummer van het voertuig mee te kunnen geven. | Ja | Nee | Query |
| unifier | Uniek identificatienummer van de nummerplaat. Dit veld mag enkel in combinatie met de parameter "vin" gebruikt worden | Nee | Nee | Query |
| certificateId | Query parameter om het unieke identificatienummer van het certificaat mee te kunnen geven. | Ja | Nee | Query |
| nationalNr | Query parameter om het rijksregisternummer van een persoon mee te kunnen geven. | Ja | Nee | Query |
| companyNr | Query parameter om het ondernemingsnummer van een bedrijf mee te kunnen geven. | Ja | Nee | Query |
| dateTime | Query parameter om de datum waarvoor u de situatie wilt kennen mee te geven. Indien er geen datum wordt meegegeven, dan wordt standaard de datum van vandaag als zoekdatum genomen. Formaat: yyyy-mm-ddTuu:mm:ss | Nee | Nee | Query |
| transactionUID | Query parameter om het uniek identificatienummer van een transactie mee te kunnen geven. | Ja | Nee | Query |
| pageSize | Veld om aan te geven hoeveel resultaten per pagina u wilt krijgen. | Nee | Nee | Query |
| after | Query parameter om aan te geven na welk element de resultaten in het antwoord opgenomen dienen te worden. | Nee | 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 | 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 | Nee | Query |
| Note | ||
|---|---|---|
| ||
|
Validaties op vraag
| Element | Omschrijving van de validatie | Mogelijke Foutcodes |
|---|---|---|
| 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 |
Opmerkingen
De verrijking met het actuele adres van de titularis is opgesplitst in 2 parameters. Om zowel voor natuurlijke personen als voor ondernemingen adresverrijking te kunnen doen, moeten beide parameters meegegeven worden.
Voorbeeld
Voorbeeld aanvraag op VIN-nummer met adres verrijking (voor natuurlijke personen zal adresverrijking bij bron rijksregister gebeuren).
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
GET /registrations?vin=WVWZZZAUZLP551560&addressEnrichmentPerson=RR&addressEnrichmentOrganization=True
|
Voorbeeld aanvraag op VIN-nummer zonder adres verrijking
| Code Block |
|---|
GET /registrations?vin=WVWZZZAUZLP551560 |
Op deze pagina
| Table of Contents | ||
|---|---|---|
|
Binnen deze handleiding
| Page Tree | ||
|---|---|---|
|