Technische Documentatie TaxatieVoertuig A2SP 2015

Transcriptie

1 Technische Documentatie TaxatieVoertuig A2SP 2015 Versie Auteur Opmerkingen Datum 1.0 YB Initiële versie Inleiding SOAP is op basis van de wsdl redelijk zelf beschrijvend. Dit document richt zich dan ook op aanvullende informatie (zowel functioneel als technisch). Methods De volgende methods zijn beschikbaar: 1. haalhistorie() 2. haalhistorieaantal() 3. haalrapport() 4. haaltaxatielijstresultaat() 5. haaltaxatielijststatus() 6. hersteltaxatielijst() 7. starttaxatielijst() 8. taxeervoertuig() Soorten taxaties Er zijn 2 werkwijzen mogelijk namelijk het taxeren van hele batches tegelijk en het taxeren van een individueel voertuig. A) Taxeren per voertuig: door het opgeven van additionele informatie is het mogelijk de taxatiewaarden te preciseren; B) Taxeren van een batch van voertuigen: op basis van kenteken en peildatum. Taxeren per voertuig De volgende methods zijn van toepassing op taxeren per voertuig : taxeervoertuig() Taxaties worden in de A2SP cloud opgeslagen per klant (bedrijf). Deze zijn alleen door de eigenaar opvraagbaar met de volgende methods: haalhistorie() : lijst met ids, kentekens en timestamps haalhistorieaantal() : totaal aantal gedane taxaties haalrapport() : levert de invoer- en uitvoerwaarden (taxaties) op Het is vanzelfsprekend ook mogelijk een eigen, lokale, historie bij te houden. 1

2 Taxeren per batch De volgende methods zijn van toepassing op batch taxaties: starttaxatielijst() Met deze method kan een lijst worden opgegeven van kentekens en een peildatum per kenteken. Na aanroep wordt er een ID teruggegeven en wordt de job in de achtergrond uitgevoerd. Dit gaat zeer snel, maar met grote aantallen kan het toch nog even duren. haaltaxatielijststatus() : bekijken van de voortgang van een job haaltaxatielijstresultaat() : als de job compleet is kan het resultaat met deze method worden opgevraagd hersteltaxatielijst() : mocht er om een of andere reden een storing geweest zijn dan kan deze method worden gebruikt voor het herstarten. Al uitgevoerde taxaties worden dan niet opnieuw gedaan Formaten Datums zijn van het type string met als format yyyy-mm-dd ( ). Kentekens zijn van het type string met als format XXXXXX, dus zonder streepjes. Voorbeeld taxeervoertuig() De voorbeelden zijn uitgewerkt mbv SOAP UI. De onderliggende XML is nogmaal gesproken weggestopt achter de SOAP API, maar wordt nu wel weergegeven om inzicht in de request & response te gegeven. Request <soapenv:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soapenv=" xmlns:tax=" xmlns:soapenc=" <soapenv:header/> <soapenv:body> <tax:taxeervoertuig soapenv:encodingstyle=" <referentie xsi:type="xsd:string">121212</referentie> <gebruiker xsi:type="xsd:string">tester10670</gebruiker> <wachtwoord xsi:type="xsd:string">*******</wachtwoord> <kenteken xsi:type="xsd:string">25jdp1</kenteken> <uitvoeringid xsi:type="xsd:string">nvt</uitvoeringid> <merkmodeltype xsi:type="xsd:string">mercedes 200 Executive</merkModelType> <datumeerstetoelating xsi:type="xsd:string"/> <voertuigsoort xsi:type="xsd:string"/> <taxatiedatum xsi:type="xsd:string"> </taxatiedatum> <kilometerstand xsi:type="xsd:int">222333</kilometerstand> 2

3 <echtenieuwprijs xsi:type="xsd:int"/> <correcties xsi:type="tax:arrayofbackend_taxatievoertuig_input_correctie" soapenc:arraytype="tax:backend_taxatievoertuig_input_correctie[]"> <soort>staatcorrectie</soort> <eenheid>euro</eenheid> <correctie>100</correctie> <soort>kleurcorrectie</soort> <eenheid>euro</eenheid> <correctie>100</correctie> <soort>handmatigecorrectie</soort> <eenheid>perc</eenheid> <correctie>20</correctie> </correcties> </tax:taxeervoertuig> </soapenv:body> </soapenv:envelope> Veldnaam Type Omschrijving Invoerwaarden referentie String Tekst om een transactie te markeren of te kunnen herkennen. gebruiker String A2SP gebruikersnaam wachtwoord String kenteken String Kenteken zonder streepjes uitvoeringid String Nvt (wegens backwardscompatibiliteit) Mag leeg gelaten worden. taxatiedatum String Peildatum waarop de taxatie wordt gebaseerd merkmodeltype String Kenteken is genoeg, maar toevoeging als executive of sports kunnen het resultaat beïnvloeden (preciezer maken). kilometerstand Int Als dit veld niet wordt opgegeven wordt er een aanname gedaan. echtenieuwprijs Int Nieuwprijs in Euro s. Wordt normaalgesproken op basis van het kenteken afgeleid. datumeerstetoelating String Wordt normaalgesproken van het kenteken afgeleid, maar kan worden opgegeven (kan relevant zijn bij importklassiekers) correcties Array van Objecten Zie XML request. Heeft als doel het positief of negatief beïnvloeden van een taxatie

4 Response <SOAP-ENV:Envelope SOAP- ENV:encodingStyle=" xmlns:soap- ENV=" xmlns:ns1=" xmlns:xsd=" xmlns:xsi=" xmlns:soap- ENC=" <SOAP-ENV:Body> <ns1:taxeervoertuigresponse> <return xsi:type="ns1:backend_taxatievoertuig_result_taxatie"> <kenteken xsi:type="xsd:string">25jdp1</kenteken> <taxatiedatum xsi:type="xsd:string"> </taxatiedatum> <resultaatcode xsi:type="xsd:string">1</resultaatcode> <handelswaarde xsi:type="xsd:int">8018</handelswaarde> <handelswaardeinclusiefbtw xsi:type="xsd:int">1</handelswaardeinclusiefbtw> <handelswaardeinclusiefbpm xsi:type="xsd:int">1</handelswaardeinclusiefbpm> <handelswaardebtw xsi:type="xsd:int">1106</handelswaardebtw> <handelswaardebpm xsi:type="xsd:int">1640</handelswaardebpm> <inruilwaarde xsi:type="xsd:int">8518</inruilwaarde> <inruilwaardeinclusiefbtw xsi:type="xsd:int">1</inruilwaardeinclusiefbtw> <inruilwaardeinclusiefbpm xsi:type="xsd:int">1</inruilwaardeinclusiefbpm> <inruilwaardebpm xsi:type="xsd:int">1640</inruilwaardebpm> <inruilwaardebtw xsi:type="xsd:int">1193</inruilwaardebtw> <verkoopwaarde xsi:type="xsd:int">9618</verkoopwaarde> <verkoopwaardeinclusiefbtw xsi:type="xsd:int">1</verkoopwaardeinclusiefbtw> <verkoopwaardeinclusiefbpm xsi:type="xsd:int">1</verkoopwaardeinclusiefbpm> <verkoopwaardebtw xsi:type="xsd:int">1384</verkoopwaardebtw> <verkoopwaardebpm xsi:type="xsd:int">1640</verkoopwaardebpm> <bedrijfswaarde xsi:nil="true"/> <bedrijfswaardeinclusiefbtw xsi:nil="true"/> <bedrijfswaardeinclusiefbpm xsi:nil="true"/> <bedrijfswaardebtw xsi:nil="true"/> <bedrijfswaardebpm xsi:nil="true"/> </return> </ns1:taxeervoertuigresponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> Veldnaam Type Omschrijving Invoerwaarden kenteken String Kenteken zonder streepjes kenteken taxatiedatum String Peildatum waarop de taxatie wordt gebaseerd resultaatcode String 1 = taxatie gelukt kenteken String Kenteken zonder streepjes Waarden Zie extra paragraaf over soorten waarden waarde Int Waarde in Euro s waardeinclusiefbtw Int 1 = met BTW waardeinclusiefbpm Int 1 = met Bpm waardebtw Int Btw in Euro s 4

5 waardebpm Int Bpm in Euro s Soorten taxatiewaarden De volgende waarden zijn beschikbaar: 1. Handelswaarde 2. Inruilwaarde 3. Verkoopwaarde 4. Bedrijfswaarde (wordt getoond in response, maar is niet beschikbaar) 5