Cartalk: Simplified REST interface

Transcriptie

1 Cartalk: Simplified REST interface Inhoud Cartalk: Simplied REST interface... 2 Inleiding... 2 Simplied REST: request syntax... 2 Failover... 2 Overzicht resultaatcodes:... 2 Response:... 3 Revisiehistorie... 5 A2SP 1

2 Cartalk: Simplied REST interface Inleiding De CarTalk Simplified REST service biedt een REST-achtige interface tot de CarTalk dienst: een request wordt middels een URL (GET method gedaan) een de response is een "standaard" Cartalk XML bericht. Simplied REST: request syntax De service is bereikbaar middels de volgende URLs: URL Acceptatie-server: *******&querytype=lp&kenteken=88jkd1&secure=0 Let op: op acceptatie is de poort anders. URL Productie-server: pe=lp&kenteken=88jkd1&secure=0 Authenticatie gebeurt op basis van username / password. Https zorgt voor de benodigde beveiliging. Failover Deze dienst is dubbel uitgevoerd. A2SP zal in noodgevallen overschakelen op de failover omgeving. Het is echter ook mogelijk dit te doen vanuit de eigen, aanroepende software. De URL van de failover server is: Overzicht resultaatcodes: resultaatcode resultaatomschrijving 1 Volledig geslaagd 2 Overcompleet Opmerking Het resultaat van de query is een perfecte 1 op 1 match Het resultaat van de query laat meerdere mogelijkheden open (bv verschillende uitvoeringen van een model) 3 Deels of niet geslaagd Bv door gebruikt van een niet bestaand kenteken 4 6 Mislukt door foutieve input Mislukt door server error Bv door gebruik van een verkeerde tag of door een foutieve veldwaarde. Er is een onbekende fout opgetreden op de server, waardoor de gevraagde gegevens niet konden worden geretourneerd. A2SP 2

3 Response: Voorbeeld van een xml bericht met RDW data. De dataset wordt echter op maat samengesteld. <?xml version="1.0" standalone="yes"?> <ctmessage> <status> <resultcode>2</resultcode> <resultdescription>overcompleet</resultdescription> <server>xml15</server> </status> <ctdata numresultsets="2"> <resultset name="" numrecords="1"> <record number="1"> <attribute name="ctresult">rdw data</attribute> <attribute name="kenteken">88jkd1</attribute> <attribute name="identificatienummer"></attribute> <attribute name="uitv_volg_nr">24522</attribute> <attribute name="voertuigsoort">personenauto</attribute> <attribute name="type_beschr_vtg">x 6</attribute> <attribute name="eerste_toel_dat"> </attribute> <attribute name="eerste_ins_dat"> </attribute> <attribute name="inrichting">stationwagen</attribute> <attribute name="type_carroserietabel">ac</attribute> <attribute name="brandstof1">benzine</attribute> <attribute name="brandstof2"></attribute> <attribute name="kleur1">wit</attribute> <attribute name="kleur2">niet VAN TOEPASSING</attribute> <attribute name="bpm_bedrag">43704</attribute> <attribute name="catalogus_prys">0</attribute> <attribute name="energielabel">e</attribute> <attribute name="wyze_invoer">i</attribute> <attribute name="actief">false</attribute> <attribute name="massa_leeg_vrtg">2165</attribute> <attribute name="max_massa_vrtg">2840</attribute> <attribute name="motor_code">n63b44a</attribute> <attribute name="aant_cyl">8</attribute> <attribute name="cyl_inhoud">4395</attribute> <attribute name="vermogen">300</attribute> <attribute name="max_constr_sn">0</attribute> <attribute name="wielbasis">293</attribute> <attribute name="lengte">488</attribute> <attribute name="breedte">0</attribute> <attribute name="emis_co2_comb">299</attribute> <attribute name="emis_deeltjes">0</attribute> <attribute name="verbr_stad">17.6</attribute> <attribute name="verbr_buiten">9.5</attribute> <attribute name="verbr_comb">12.5</attribute> <attribute name="emissie_code"></attribute> <attribute name="apk_meld_dat"> </attribute> <attribute name="apk_verv_dat">0</attribute> <attribute name="afg_dat_kent"> </attribute> <attribute name="mut_dat_vrtg"> </attribute> <attribute name="verzekerd_ind">j</attribute> <attribute name="pl_code_vrtg_id">r </attribute> <attribute name="massa_bedr_kl">2265</attribute> <attribute name="max_mas_vrtg_t">2840</attribute> <attribute name="max_mas_samenst">6480</attribute> <attribute name="max_mas_ger">3500</attribute> <attribute name="max_mas_aut_ger">0</attribute> <attribute name="max_mas_mid_ger">3500</attribute> <attribute name="max_mas_opl_ger">0</attribute> A2SP 3

4 <attribute name="max_mas_ong">750</attribute> <attribute name="max_last_kop">0</attribute> <attribute name="type_goedk_nr">e1*2001/116*0420*04</attribute> <attribute name="etk_sleutel">e1*01/116*0420*04</attribute> <attribute name="land_code_etk">e1</attribute> <attribute name="richtl_nr_l_w">01/116</attribute> <attribute name="eeg_basis_gk_nr">420</attribute> <attribute name="eeg_uitbr_gk_nr">4</attribute> <attribute name="eeg_tgk_nr_23"></attribute> <attribute name="eeg_type_gk_nr"></attribute> <attribute name="eeg_var_code">fg81</attribute> <attribute name="eeg_uitv_code">gb</attribute> <attribute name="uitv_wyz_nr">00</attribute> <attribute name="bromf_cat_code"></attribute> <attribute name="bromf_tgk_nr">0000</attribute> <attribute name="uitv_volg_nr_ah">00000</attribute> <attribute name="var_nr_aanh">00</attribute> <attribute name="var_code_aanh"></attribute> <attribute name="eeg_vrtg_cat">m1</attribute> <attribute name="eeg_vrtg_cat_tv"></attribute> <attribute name="eeg_uitv_cat_tv">g</attribute> <attribute name="aant_wielen">4</attribute> <attribute name="assentabel"> </attribute> <attribute name="h_kop_az_vrtg">0</attribute> <attribute name="vz_vrtg_h_kop">0</attribute> <attribute name="vermogen_br">0</attribute> <attribute name="afw_max_snelh">0</attribute> <attribute name="aant_zitpl">4</attribute> <attribute name="aant_staanpl">0</attribute> <attribute name="aant_deuren">4</attribute> <attribute name="geluid_niv">88</attribute> <attribute name="toeren_gel_niv">4125</attribute> <attribute name="gas_tank_inhoud">0</attribute> <attribute name="merk_c_toev_o"></attribute> <attribute name="merk_o_toegev"></attribute> <attribute name="type_o_toegev"></attribute> <attribute name="gebrekentabel"> </attribute> <attribute name="verv_dat_keur"> </attribute> </record> </resultset> <resultset name="" numrecords="3"> <record number="1"> <attribute name="ctresult2">carbase data</attribute> <attribute name="a2spid"> </attribute> <attribute name="type">x6 xdrive50i</attribute> <attribute name="schakeling">t</attribute> </record> <record number="2"> <attribute name="ctresult2">carbase data</attribute> <attribute name="a2spid"> </attribute> <attribute name="type">x6 xdrive50i Executive</attribute> <attribute name="schakeling">t</attribute> </record> <record number="3"> <attribute name="ctresult2">carbase data</attribute> <attribute name="a2spid"> </attribute> <attribute name="type">x6 xdrive50i High Executive</attribute> <attribute name="schakeling">t</attribute> </record> </resultset> </ctdata> </ctmessage> A2SP 4

5 Revisiehistorie Revisiehistorie Auteur Datum Omschrijving Versie 1.0 Yves van den Berg Initiële versie A2SP 5