Benutzer-Werkzeuge

Webseiten-Werkzeuge


dokumentation_der_soap_schnittstelle_version_3.0

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
Nächste Überarbeitung
Vorhergehende Überarbeitung
dokumentation_der_soap_schnittstelle_version_3.0 [2018-04-11 19:01]
admin /* calcCar */
dokumentation_der_soap_schnittstelle_version_3.0 [2018-11-07 23:21] (aktuell)
admin [calcCar] Link gefixt
Zeile 1: Zeile 1:
 +====== Dokumentation der SOAP Schnittstelle Version 3.0 ======
 +
 **Bitte beachten Sie, dass die SOAP-APIs nicht mehr aktiv weiterentwickelt werden.** **Bitte beachten Sie, dass die SOAP-APIs nicht mehr aktiv weiterentwickelt werden.**
 Neue Kunden sollten ausschließlich die RESTful API nutzen, bestehende Nutzer der SOAP-Schnittstellen sollten mittelfristig auf REST umstellen.**** Neue Kunden sollten ausschließlich die RESTful API nutzen, bestehende Nutzer der SOAP-Schnittstellen sollten mittelfristig auf REST umstellen.****
Zeile 5: Zeile 7:
  
  
-====== SOAP-Zugangsdaten =====+===== SOAP-Zugangsdaten =====
  
-  *  Proxy / SOAP-Server:​ <​code>​https://​autofokus24.de/​SoapServer3.php</​code>​ 
-  *  WSDL-Datei: <​code>​https://​autofokus24.de/​genwsdl.php?​type=hsntsn-v3</​code>​ 
-  *  Encoding: <​code>​utf-8</​code>​ 
-  *  Namespace/​URN:​ <​code>​autofokus24</​code>​ 
  
 +  * Proxy / SOAP-Server:​ ''​https://​autofokus24.de/​SoapServer3.php''​
 +  * WSDL-Datei: ''​https://​autofokus24.de/​genwsdl.php?​type=hsntsn-v3''​
 +  * Encoding: ''​utf-8''​
 +  * Namespace/​URN:​ ''​autofokus24''​
  
-====== Funktionen ====== 
  
 +===== Funktionen =====
  
  
-===== login =====+==== login ====
  
  
-Syntax: ​<​code>​bool login(string username, string password [, bool useSoapFaults = false])</​code>​+Syntax: ​''​bool login(string username, string password [, bool useSoapFaults = false])''​
  
 Mit dieser Funktion loggen Sie sich mit Ihrem Nutzernamen/​Passwort im System ein. Der Login wird serverseitig in einer Mit dieser Funktion loggen Sie sich mit Ihrem Nutzernamen/​Passwort im System ein. Der Login wird serverseitig in einer
 Session gehalten, dafür ist es aber notwendig, dass Sie clientseitig das Setzen von Cookies ermöglichen. Session gehalten, dafür ist es aber notwendig, dass Sie clientseitig das Setzen von Cookies ermöglichen.
  
-  *  Parameter +  * Parameter 
-    *  <​code>​username</​code>​: Ihr Nutzername +    * ''​username''​: Ihr Nutzername 
-    *  <​code>​password</​code>​: Ihr Passwort +    * ''​password''​: Ihr Passwort 
-  *  Rückgabewert +  * Rückgabewert 
- ​Liefert true im Erfolgsfall zurück. Liefert false im Fehlerfall zurück. Sollte die Ausnahmebehandlung aktiviert sein (<​code>​useSoapFaults=true</​code>​) wird ein Fehler (Exception) geworfen.+    ​* ​Liefert true im Erfolgsfall zurück. Liefert false im Fehlerfall zurück. Sollte die Ausnahmebehandlung aktiviert sein (''​useSoapFaults=true''​) wird ein Fehler (Exception) geworfen.
  
  
-===== calcCar ​=====+==== calcCar ====
  
  
-Syntax: ​<​code>​array calcCar(string hsn, string tsn, int year, int month, int miles+Syntax: ​''​array calcCar(string hsn, string tsn, int year, int month, int miles
 [, string fuzzyText = ""​ [, string model = ""​ [, string subModel = ""​ [, string specialModel = ""​ [, string fuzzyText = ""​ [, string model = ""​ [, string subModel = ""​ [, string specialModel = ""​
 [, bool returnAllSpecialmodels = false [, bool useProductionTolerance = false [, bool returnAllSpecialmodels = false [, bool useProductionTolerance = false
 [, string featureList = ""​ [, string color = ""​ [, int buildType = 0 [, int doorCount = 0 [, string featureList = ""​ [, string color = ""​ [, int buildType = 0 [, int doorCount = 0
 [, int dealerSize = 0 [, int priceClass = 0 [, int carVolume = 0 [, int garantieValue = 0 [, int dealerSize = 0 [, int priceClass = 0 [, int carVolume = 0 [, int garantieValue = 0
-[, int monthWaitForSell = 0 [, int milesPerYear = 0 [, int usageYearCount = 0 ]]]]]]]]]]]]]]]])</​code>​+[, int monthWaitForSell = 0 [, int milesPerYear = 0 [, int usageYearCount = 0 ]]]]]]]]]]]]]]]])''​
  
 Diese Funktion liefert Ihnen ein Array mit den Daten des erkannten Fahrzeuges, sowie den berechneten Verkaufspreis Diese Funktion liefert Ihnen ein Array mit den Daten des erkannten Fahrzeuges, sowie den berechneten Verkaufspreis
 (price) und den Händlereinkaufspreis (priceEK). (price) und den Händlereinkaufspreis (priceEK).
  
-Wenn die Option returnAllSpecialmodels gesetzt ist, und wenn die übergebenen Parameter nicht eindeutig  +Wenn die Option ​''​returnAllSpecialmodels'' ​gesetzt ist, und wenn die übergebenen Parameter nicht eindeutig 
-auf ein bestimmtes Sondermodell der Baureihe verweisen (häufig der Fall bei fehlender Angabe des Sondermodells  +auf ein bestimmtes Sondermodell der Baureihe verweisen (häufig der Fall bei fehlender Angabe des Sondermodells 
-(specialModel),​ dann wird eine Liste aus mehreren Arrays zurückgegeben.  +(specialModel),​ dann wird eine Liste aus mehreren Arrays zurückgegeben. 
-Für jedes mögliche ​Sondermodellwerden ​alle Preise berechnet. Sie können dann programmseitig das korrekte Fahrzeug auswählen, ​+Für jedes mögliche ​Sondermodell werden ​alle Preise berechnet. Sie können dann programmseitig das korrekte Fahrzeug auswählen,
 oder die Parameter für eine erneute Anfrage entsprechend einschränken. oder die Parameter für eine erneute Anfrage entsprechend einschränken.
  
Zeile 57: Zeile 58:
 Zum Beispiel trifft die HSN/​TSN-Kombination 8566/AAH für die Modelle Ford Focus, Ford C-Max und Ford Kuga zu. Zum Beispiel trifft die HSN/​TSN-Kombination 8566/AAH für die Modelle Ford Focus, Ford C-Max und Ford Kuga zu.
  
-Seit Version 1.2 werden auch Standzeitinformationen (siehe [[standzeiten]]) sowie Verkaufswahrscheinlichkeiten (siehe +Seit Version 1.2 werden auch Standzeitinformationen (siehe [[standzeit|Standzeiten]]) sowie Verkaufswahrscheinlichkeiten (siehe 
-[[verkaufswahrscheinlichkeit]]) zurückgegeben.+[[verkaufswahrscheinlichkeit]]) zurückgegeben. Sie übergeben dazu die Option ''​monthWaitForSell''​ und 
 +übergeben die Dauer in Monaten, welche Fahrzeuge bei dem betrachteten Händler bzw. der Handelsplattform stehen sollen. 
 +Für sehr schnell drehende Händler übergeben Sie einen Wert von 1 (für einen Monat gewünschte Standzeit im Mittel). 
 +Wir empfehlen 3-4 Monate für größere Autohäuser,​ Markenhändler,​ damit die berechneten Preise nicht zu tief sind. 
 + 
 +Die Option ''​useProductionTolerance''​ dehnt die Produktionszeiträume zur Suche nach passenden Fahrzeugen aus. 
 +Falls in der Fahrzeugbeschreibung eine falsch eingegebene EZ vorliegt, oder die EZ weit nach dem Ende des Produktionszeitraum war, 
 +werden Fahrzeuge normalerweise nicht gefunden. Die Toleranz dehnt das Suchintervall in unserer Datenbank nach vorne um 2 Monate, 
 +nach hinten um 12 Monate aus. Die Option ist auch sinnvoll, da die Angaben zu den Produktionsstarts in unseren Quellen 
 +teilweise nicht exakt sind.
  
 Optional können auch weitere Parameter zur Händlergröße angegeben werden. Durch die Angaben der Händlerinformationen Optional können auch weitere Parameter zur Händlergröße angegeben werden. Durch die Angaben der Händlerinformationen
 können realistischere Verkaufspreise ermittelt werden. Die Berechnung des Einkaufspreises bleibt davon unberührt. Zu den können realistischere Verkaufspreise ermittelt werden. Die Berechnung des Einkaufspreises bleibt davon unberührt. Zu den
 Händlerinformationen gehören die Parameter dealerSize, priceClass, carVolume sowie garantieValue. Weitere Informationen Händlerinformationen gehören die Parameter dealerSize, priceClass, carVolume sowie garantieValue. Weitere Informationen
-zur Händlergröße finden Sie unter [[handlergroen]]. +zur Händlergröße finden Sie unter [[haendlergroessen]].
- +
-  *  Parameter +
-    *  <​code>​hsn</​code>:​ Die 4-stellige Herstellerschlüsselnummer gemäß Kraftfahrzeugbundesamt +
-    *  <​code>​tsn</​code>:​ Die 3-stellige Typschlüsselnummer gemäß Kraftfahrzeugbundesamt +
-    *  <​code>​year</​code>:​ Das Jahr der Erstzulassung +
-    *  <​code>​month</​code>:​ Der Monat der Erstzulassung +
-    *  <​code>​miles</​code>:​ Laufleistung in Kilometern +
-    *  <​code>​fuzzyText</​code>:​ (optional) Hier kann der Freitext übergeben werden, mit dessen Hilfe die interne künstliche Intelligenz die Ausstattungen,​ Extras, Farbe, Sondermodell usw. erkannt wird. Als Freitext eignet sich beispielsweise die Inseratsbeschreibung inkl. Titel eines angebotenen Fahrzeuges. +
-    *  <​code>​model</​code>:​ (optional) Der Name eines bestimmten Modells (z.B.: "​A3"​ oder "​Mégane"​...) +
-    *  <​code>​subModel</​code>:​ (optional) Der Name einer bestimmten Baureihe (z.B.: "​Modell ab 2015 (Facelift)"​ oder "Golf 7"​...) +
-    *  <​code>​specialModel</​code>:​ (optional) Der Name eines bestimmten Sondermodells (z.B.: "​Elegance"​ oder "​Highline"​...) +
-    *  <​code>​returnAllSpecialmodels</​code>:​ (optional) Alle gefundenen Sondermodelle zurückgeben,​ wenn hier true übergeben wird. +
-    *  <​code>​useProductionTolerance</​code>:​ (optional) Toleranzen um Produktionszeiträume beachten, wenn hier true übergeben wird. +
-    *  <​code>​featureList</​code>:​ (optional) Eine Kommaseparierte Liste an Kürzel/​Shortcuts von expliziten Extras oder Ausstattungsmerkmalen (z.B.: "​KLI,​AIB,​NAV,​PDC"​) Die Funktion getFeatureList(...) liefert Ihnen eine Liste an möglichen Extras und deren Kürzel/​Shortcuts. Hier können auch Werte für die Garantie/​Gewährleistung übergeben werden, mit welcher das Fahrzeug verkauft werden soll. Die Garantieleistungen beeinflussen ebenfalls den Fahrzeugwert. Hier können folgende weitere Kürzel/​Shortcuts für die Garantieleistung übergeben werden: +
- OGEW = Verkauf ohne Gewährleistung +
- ​NO_OGEW = Verkauf mit Gewährleistung +
- ​GARANTIE = Verkauf mit Garantie +
- ​GARANTIE_MARKE = Verkauf mit Markengarantie +
- ​GARANTIE_HERSTELLER = Verkauf mit Herstellergarantie +
-    *  <​code>​color</​code>:​ (optional) Das Kürzel/​Shortcut der Farbe des Fahrzeuges. (z.B.: "​RED"​) Die Funktion getColors(...) liefert Ihnen eine Liste an möglichen Farben und deren Kürzel/​Shortcuts. +
-    *  <​code>​buildType</​code>:​ (optional) Die Aufbauvariante des Fahrzeuges (1 = Limousine, 2 = Kombi/Van, 3 = Coupe, 4 = Cabrio). +
-    *  <​code>​doorCount</​code>:​ (optional) Anzahl der Türen. +
-    *  <​code>​dealerSize</​code>:​ (optional) Die Unternehmensart,​ mit welcher der Verkäufer des Fahrzeuges agiert. Es können dabei folgende Werte übergeben werden: +
- 1 = Vertrags- bzw. Markenhändler +
- 2 = Freier Händler der Luxusklasse +
- 3 = Freier Neuwagen- und Jahreswagenhändler +
- 4 = Freier Händler +
- 5 = Freier Händler, überwiegend Export +
- 6 = Gutachter/​Makler +
- 7 = Steuerberater/​Versicherung +
- 8 = Werkstatt mit kleinem Handel +
-    *  <​code>​priceClass</​code>:​ (optional) Preisklasse im Durchschnitt,​ welche der Verkäufer handelt: +
- 0 = kein Handel +
- 1 = 0 - 5.000 € +
- 2 = 5.000 - 10.000 € +
- 3 = 10.000 - 15.000 € +
- 4 = 15.000 - 20.000 € +
- 5 = 20.000 - 30.000 € +
- 6 = 30.000 - 40.000 € +
- 7 = über 40.000 € +
-    *  <​code>​carVolume</​code>:​ (optional) Fahrzeugbestand im Durchschnitt,​ welche der Verkäufer handelt: +
- 0 = kein Handel +
- 1 = 0 - 5 Fahrzeuge +
- 2 = 5 - 10 Fahrzeuge +
- 3 = 10 - 20 Fahrzeuge +
- 4 = 20-50 Fahrzeuge +
- 5 = 50-100 Fahrzeuge +
- 6 = 100-250 Fahrzeuge +
- 7 = 250-1.000 Fahrzeuge +
- 8 = über 1.000 Fahrzeuge +
-    *  <​code>​garantieValue</​code>:​ (optional) Garantieleistungen,​ welche der Verkäufer für gewöhnlich anbietet: +
- 0 = kein Handel +
- 1 = Verkäufe überwiegend ohne Gewährleistung +
- 2 = Verkäufe überwiegend mit Gewährleistung,​ ohne Garantie. +
- 3 = Verkäufe überwiegend mit Garantieversicherung. +
- 4 = Verkäufe überwiegend mit Herstellergarantie. +
-    *  <​code>​monthWaitForSell</​code>:​ (optional) Zeitraum der Wartezeit in Monaten, die Fahrzeuge beim Händler maximal stehen sollen. Daraus werden die Verkaufswahrscheinlichkeiten (siehe [[verkaufswahrscheinlichkeit]] sowie [[wahrscheinlichkeit]]) berechnet. Realistisch sind hierbei Werte zwischen 1 und 6. Wird beispielsweise der Wert 2 übergeben, dann wird im Rückgabewert ein Array mit Preisen und dazugehörigen Verkaufswahrscheinlichkeiten geliefert, welche die Wahrscheinlichkeit für den Verkauf innerhalb von 2 Monaten bewerten. Je kürzer die maximale Wartezeit, desto geringer sind die berechneten Verkaufspreise. Empfehlung: Verwenden Sie hier 2 bis 3 Monate. +
-    *  <​code>​milesPerYear</​code>:​ (optional) Für die Restwertprognose:​ Die Laufleistung pro Jahr in Kilometern +
-    *  <​code>​usageYearCount</​code>:​ (optional) Für die Restwertprognose:​ Die geplante Nutzungsdauer in Jahren +
- +
-  *  Rückgabewert +
- ​Liefert im Erfolgsfall ein Array oder eine Liste an Arrays zurück mit den genauen Daten des erkannten Fahrzeuges und die geschätzten Fahrzeugpreise. +
- Dabei ist "​price"​ der Verkaufspreis und "​priceEK"​ der Händlereinkaufspreis. Alle weiteren Daten erklären sich quasi von selbst. +
- Wenn kein Fahrzeug erkannt wird, wird ein leeres Array zurückgegeben. +
- +
- Für die erkannten Ausstattungsmerkmale gibt es zusätzlich eine Reihe von Rückgabewerten:​+
  
- <​code>​extras</​code>​: Dieses Array enthält die spezifische Ausstattung des gelieferten Kfz. Das ist die Summe der Ausstattungen extrasByDate,​ extrasByMotor,​ extrasBySpecialModel und der im Fuzzytext erkannten Sonderausstattung.  +  * Parameter 
- <​code>​extrasByDate</​code>​: Sind die Ausstattungsmerkmale welche das Fahrzeug anhand seiner Grundausstattung und Bauzeit hat (Analog der Darstellung auf der Autofokus24-Website "​Grundausstattung nach Bauzeit"​). +    * ''​hsn'':​ Die 4-stellige Herstellerschlüsselnummer gemäß Kraftfahrzeugbundesamt 
- <​code>​extrasByMotor</​code>​: Sind die zusätzlichen Ausstattungsmerkmale welche das Fahrzeug aufgrund seiner Motorisierung hat (Analog der Darstellung auf der Autofokus24-Website "​Zusatzausstattung durch Motorisierung"​). +    * ''​tsn'':​ Die 3-stellige Typschlüsselnummer gemäß Kraftfahrzeugbundesamt 
- <​code>​extrasBySpecialModel</​code>​: Sind die zusätzlichen Ausstattungsmerkmale welche das Fahrzeug aufgrund seines Sondermodells hat (Analog der Darstellung auf der Autofokus24-Website "​Zusatzausstattung durch Sondermodell"​). +    * ''​year'':​ Das Jahr der Erstzulassung 
- <​code>​significantExtras</​code>​: Sind die möglichen weiteren Ausstattungsmerkmale welche sich gemäß der Autofokus24-Schätzung statistisch relevant auf den Fahrzeugwert auswirken (Analog der Darstellung auf der Autofokus24-Website "​Weitere Ausstattung"​). +    * ''​month'':​ Der Monat der Erstzulassung 
- <​code>​avgSellingTimeAtPrice</​code>​: Ist die durchschnittliche Standzeit in Tagen bis zum Verkauf bei Marktpreis (price). +    * ''​miles'':​ Laufleistung in Kilometern 
- <​code>​avgSellingTimes</​code>​: Ist ein Array bestehend aus 2-Tupeln(Verkaufspreis,​ Verkaufswahrhscheinlichkeit). Es werden dabei stufenweise Preise +/- um den Marktpreis und die zugehörigen Verkaufswahrscheinlichkeiten berechnet. Die Verkaufswahrscheinlichkeit bezieht sich dabei auf die übergebene Wartezeit (monthWaitForSell). Wenn also monthWaitForSell=2 übergeben wurde, und das avgSellingTimes-Array den Eintrag [3900;66] enthält, dann bedeutet es, dass bei einem Verkaufspreis von 3900 Euro die Wahrscheinlichkeit für den Verkauf innerhalb von 2 Monaten 66% beträgt. +    * ''​fuzzyText'':​ (optional) Hier kann der Freitext übergeben werden, mit dessen Hilfe die interne künstliche Intelligenz die Ausstattungen,​ Extras, Farbe, Sondermodell usw. erkannt wird. Als Freitext eignet sich beispielsweise die Inseratsbeschreibung inkl. Titel eines angebotenen Fahrzeuges. 
- <​code>​degeneration</​code>​: Ein Array mit <​code>​usageYearCount</​code>​*12 Einträgen, die jeweils den Restwert pro Monat ab dem aktuellen Monat angeben. Wird berechnet, wenn <​code>​milesPerYear</​code> ​und <​code>​usageYearCount</​code> ​übergeben wurden.+    * ''​model'':​ (optional) Der Name eines bestimmten Modells (z.B.: "​A3"​ oder "​Mégane"​...) 
 +    * ''​subModel'':​ (optional) Der Name einer bestimmten Baureihe (z.B.: "​Modell ab 2015 (Facelift)"​ oder "Golf 7"​...) 
 +    * ''​specialModel'':​ (optional) Der Name eines bestimmten Sondermodells (z.B.: "​Elegance"​ oder "​Highline"​...) 
 +    * ''​returnAllSpecialmodels'':​ (optional) Alle gefundenen Sondermodelle zurückgeben,​ wenn hier true übergeben wird. 
 +    * ''​useProductionTolerance'':​ (optional) Toleranzen um Produktionszeiträume beachten, wenn hier true übergeben wird. 
 +    * ''​featureList'':​ (optional) Eine Kommaseparierte Liste an Kürzel/​Shortcuts von expliziten Extras oder Ausstattungsmerkmalen (z.B.: "​KLI,​AIB,​NAV,​PDC"​) Die Funktion getFeatureList(...) liefert Ihnen eine Liste an möglichen Extras und deren Kürzel/​Shortcuts. Hier können auch Werte für die Garantie/​Gewährleistung übergeben werden, mit welcher das Fahrzeug verkauft werden soll. Die Garantieleistungen beeinflussen ebenfalls den Fahrzeugwert. Hier können folgende weitere Kürzel/​Shortcuts für die Garantieleistung übergeben werden: 
 +      * ''​OGEW''​ = Verkauf ohne Gewährleistung 
 +      * ''​NO_OGEW''​ = Verkauf mit Gewährleistung 
 +      * ''​GARANTIE''​ = Verkauf mit Garantie 
 +      * ''​GARANTIE_MARKE''​ = Verkauf mit Markengarantie 
 +      * ''​GARANTIE_HERSTELLER''​ = Verkauf mit Herstellergarantie 
 +    * ''​color'':​ (optional) Das Kürzel/​Shortcut der Farbe des Fahrzeuges. (z.B.: "​RED"​) Die Funktion getColors(...) liefert Ihnen eine Liste an möglichen Farben und deren Kürzel/​Shortcuts. 
 +    * ''​buildType'':​ (optional) Die Aufbauvariante des Fahrzeuges (1 = Limousine, 2 = Kombi/Van, 3 = Coupe, 4 = Cabrio). 
 +    * ''​doorCount'':​ (optional) Anzahl der Türen. 
 +    * ''​dealerSize'':​ (optional) Die Unternehmensart,​ mit welcher der Verkäufer des Fahrzeuges agiert. Es können dabei folgende Werte übergeben werden: 
 +      * 1 = Vertrags- bzw. Markenhändler 
 +      * 2 = Freier Händler der Luxusklasse 
 +      * 3 = Freier Neuwagen- und Jahreswagenhändler 
 +      * 4 = Freier Händler 
 +      * 5 = Freier Händler, überwiegend Export 
 +      * 6 = Gutachter/​Makler 
 +      * 7 = Steuerberater/​Versicherung 
 +      * 8 = Werkstatt mit kleinem Handel 
 +    * ''​priceClass'':​ (optional) Preisklasse im Durchschnitt,​ welche der Verkäufer handelt: 
 +      * 0 = kein Handel 
 +      * 1 = 0 - 5.000 € 
 +      * 2 = 5.000 - 10.000 € 
 +      * 3 = 10.000 - 15.000 € 
 +      * 4 = 15.000 - 20.000 € 
 +      * 5 = 20.000 - 30.000 € 
 +      * 6 = 30.000 - 40.000 € 
 +      * 7 = über 40.000 € 
 +    * ''​carVolume'':​ (optional) Fahrzeugbestand im Durchschnitt,​ welche der Verkäufer handelt: 
 +      * 0 = kein Handel 
 +      * 1 = 0 - 5 Fahrzeuge 
 +      * 2 = 5 - 10 Fahrzeuge 
 +      * 3 = 10 - 20 Fahrzeuge 
 +      * 4 = 20-50 Fahrzeuge 
 +      * 5 = 50-100 Fahrzeuge 
 +      * 6 = 100-250 Fahrzeuge 
 +      * 7 = 250-1.000 Fahrzeuge 
 +      * 8 = über 1.000 Fahrzeuge 
 +    * ''​garantieValue'':​ (optional) Garantieleistungen,​ welche der Verkäufer für gewöhnlich anbietet: 
 +      * 0 = kein Handel 
 +      * 1 = Verkäufe überwiegend ohne Gewährleistung 
 +      * 2 = Verkäufe überwiegend mit Gewährleistung,​ ohne Garantie. 
 +      * 3 = Verkäufe überwiegend mit Garantieversicherung. 
 +      * 4 = Verkäufe überwiegend mit Herstellergarantie. 
 +    * ''​monthWaitForSell'':​ (optional) Zeitraum der Wartezeit in Monaten, die Fahrzeuge beim Händler maximal stehen sollen. Daraus werden die Verkaufswahrscheinlichkeiten (siehe [[verkaufswahrscheinlichkeit]] sowie [[wahrscheinlichkeit]]) berechnet. Realistisch sind hierbei Werte zwischen 1 und 6. Wird beispielsweise der Wert 2 übergeben, dann wird im Rückgabewert ein Array mit Preisen und dazugehörigen Verkaufswahrscheinlichkeiten geliefert, welche die Wahrscheinlichkeit für den Verkauf innerhalb von 2 Monaten bewerten. Je kürzer die maximale Wartezeit, desto geringer sind die berechneten Verkaufspreise. Empfehlung: Verwenden Sie hier 2 bis 3 Monate. 
 +    * ''​milesPerYear'':​ (optional) Für die Restwertprognose:​ Die Laufleistung pro Jahr in Kilometern 
 +    * ''​usageYearCount'':​ (optional) Für die Restwertprognose:​ Die geplante Nutzungsdauer in Jahren 
 +  * Rückgabewert 
 +    * Liefert im Erfolgsfall ein Array oder eine Liste an Arrays zurück mit den genauen Daten des erkannten Fahrzeuges und die geschätzten Fahrzeugpreise.\\ Dabei ist "​price"​ der Verkaufspreis und "​priceEK"​ der Händlereinkaufspreis. Alle weiteren Daten erklären sich quasi von selbst.\\ Wenn kein Fahrzeug erkannt wird, wird ein leeres Array zurückgegeben. 
 +    * Für die erkannten Ausstattungsmerkmale gibt es zusätzlich eine Reihe von Rückgabewerten:​ 
 +      * ''​extras''​: Dieses Array enthält die spezifische Ausstattung des gelieferten Kfz. Das ist die Summe der Ausstattungen extrasByDate,​ extrasByMotor,​ extrasBySpecialModel und der im Fuzzytext erkannten Sonderausstattung. 
 +      * ''​extrasByDate''​: Sind die Ausstattungsmerkmale welche das Fahrzeug anhand seiner Grundausstattung und Bauzeit hat (Analog der Darstellung auf der Autofokus24-Website "​Grundausstattung nach Bauzeit"​). 
 +      * ''​extrasByMotor''​: Sind die zusätzlichen Ausstattungsmerkmale welche das Fahrzeug aufgrund seiner Motorisierung hat (Analog der Darstellung auf der Autofokus24-Website "​Zusatzausstattung durch Motorisierung"​). 
 +      * ''​extrasBySpecialModel''​: Sind die zusätzlichen Ausstattungsmerkmale welche das Fahrzeug aufgrund seines Sondermodells hat (Analog der Darstellung auf der Autofokus24-Website "​Zusatzausstattung durch Sondermodell"​). 
 +      * ''​significantExtras''​: Sind die möglichen weiteren Ausstattungsmerkmale welche sich gemäß der Autofokus24-Schätzung statistisch relevant auf den Fahrzeugwert auswirken (Analog der Darstellung auf der Autofokus24-Website "​Weitere Ausstattung"​). 
 +      * ''​avgSellingTimeAtPrice''​: Ist die durchschnittliche Standzeit in Tagen bis zum Verkauf bei Marktpreis (price). 
 +      * ''​avgSellingTimes''​: Ist ein Array bestehend aus 2-Tupeln(Verkaufspreis,​ Verkaufswahrhscheinlichkeit). Es werden dabei stufenweise Preise +/- um den Marktpreis und die zugehörigen Verkaufswahrscheinlichkeiten berechnet. Die Verkaufswahrscheinlichkeit bezieht sich dabei auf die übergebene Wartezeit (monthWaitForSell). Wenn also monthWaitForSell=2 übergeben wurde, und das avgSellingTimes-Array den Eintrag [3900;66] enthält, dann bedeutet es, dass bei einem Verkaufspreis von 3900 Euro die Wahrscheinlichkeit für den Verkauf innerhalb von 2 Monaten 66% beträgt. 
 +      * ''​degeneration''​: Ein Array mit ''​usageYearCount''​*12 Einträgen, die jeweils den Restwert pro Monat ab dem aktuellen Monat angeben. Wird berechnet, wenn ''​milesPerYear'' ​und ''​usageYearCount'' ​übergeben wurden.
  
  
-===== getFeatureList ​=====+==== getFeatureList ====
  
  
-Syntax: ​<​code>​array getFeatureList ([username = "",​ password = ""​])</​code>​+Syntax: ​''​array getFeatureList ([username = "",​ password = ""​])''​
  
 Diese Funktion liefert Ihnen ein Array der möglichen Ausstattungen/​Extras und dessen Kürzel/​Shortcuts,​ welche bei der Diese Funktion liefert Ihnen ein Array der möglichen Ausstattungen/​Extras und dessen Kürzel/​Shortcuts,​ welche bei der
 Funktion calcCar(...) explizit übergeben werden können. Funktion calcCar(...) explizit übergeben werden können.
  
-  *  Parameter +  * Parameter 
- <​code>​username</​code>​: (optional) Ihr Nutzername, falls das Sessionhandling durch die Funktion login(...) nicht funktioniert. +    * ''​username''​: (optional) Ihr Nutzername, falls das Sessionhandling durch die Funktion login(...) nicht funktioniert. 
- <​code>​password</​code>​: (optional) Ihr Passwort, falls das Sessionhandling durch die Funktion login(...) nicht funktioniert. +    * ''​password''​: (optional) Ihr Passwort, falls das Sessionhandling durch die Funktion login(...) nicht funktioniert. 
-  *  Rückgabewert +  * Rückgabewert 
- ​Liefert ein Array mit den möglichen Ausstattungen/​Extras und dessen Kürzel/​Shortcuts zurück. Im Fehlerfall wird ein leeres Array zurückgegeben. Sollte die Ausnahmebehandlung aktiviert sein (useSoapFaults=true) wird ein Fehler (Execption) geworfen.+    ​* ​Liefert ein Array mit den möglichen Ausstattungen/​Extras und dessen Kürzel/​Shortcuts zurück. Im Fehlerfall wird ein leeres Array zurückgegeben. Sollte die Ausnahmebehandlung aktiviert sein (useSoapFaults=true) wird ein Fehler (Execption) geworfen.
  
  
-===== getColors ​=====+==== getColors ====
  
  
-Syntax: ​<​code>​array getColors ([username = "",​ password = ""​]) ​</​code>​+Syntax: ​''​array getColors ([username = "",​ password = ""​]) ​''​
  
 Diese Funktion liefert Ihnen ein Array der möglichen Farben und dessen Kürzel/​Shortcuts,​ welche bei der Funktion Diese Funktion liefert Ihnen ein Array der möglichen Farben und dessen Kürzel/​Shortcuts,​ welche bei der Funktion
 calcCar(...) explizit übergeben werden können. calcCar(...) explizit übergeben werden können.
  
-  *  Parameter +  * Parameter 
- <​code>​username</​code>​: (optional) Ihr Nutzername, falls das Sessionhandling durch die Funktion login(...) nicht funktioniert. +    * ''​username''​: (optional) Ihr Nutzername, falls das Sessionhandling durch die Funktion login(...) nicht funktioniert. 
- <​code>​password</​code>​: (optional) Ihr Passwort, falls das Sessionhandling durch die Funktion login(...) nicht funktioniert. +    * ''​password''​: (optional) Ihr Passwort, falls das Sessionhandling durch die Funktion login(...) nicht funktioniert. 
-  *  Rückgabewert +  * Rückgabewert 
- ​Liefert ein Array mit den möglichen Farben und dessen Kürzel/​Shortcuts zurück. Im Fehlerfall wird ein leeres Array zurückgegeben. Sollte die Ausnahmebehandlung aktiviert sein (useSoapFaults=true) wird ein Fehler (Execption) geworfen.+    ​* ​Liefert ein Array mit den möglichen Farben und dessen Kürzel/​Shortcuts zurück. Im Fehlerfall wird ein leeres Array zurückgegeben. Sollte die Ausnahmebehandlung aktiviert sein (useSoapFaults=true) wird ein Fehler (Execption) geworfen.
  
  
-===== getLastError ​=====+==== getLastError ====
  
  
-Syntax: ​<​code>​array getLastError () </​code>​+Syntax: ​''​array getLastError () ''​
  
 Liefert den letzten aufgetretenen Fehler falls vorhanden. Liefert den letzten aufgetretenen Fehler falls vorhanden.
  
-  *  Rückgabewert +  * Rückgabewert 
- ​Liefert den Fehlercode (errorcode) und die Fehlerbeschreibung (faultstring) des letzten Fehlers zurück, falls ein Fehler aufgetreten ist. Liegt kein Fehler vor, sind die beiden zurückgegebenen Felder leer.+    ​* ​Liefert den Fehlercode (errorcode) und die Fehlerbeschreibung (faultstring) des letzten Fehlers zurück, falls ein Fehler aufgetreten ist. Liegt kein Fehler vor, sind die beiden zurückgegebenen Felder leer.
  
  
-====== Tutorials ​======+===== Tutorials =====
  
  
Zeile 189: Zeile 194:
  
  
-===== PHP-Tutorial ​=====+==== PHP-Tutorial ====
  
  
Zeile 196: Zeile 201:
 Code: Code:
  
-<​code><?​php+<​code>​ 
 +<?php
 try { try {
 /* Initialisierung:​ WSDL-Datei angeben, Caching deaktivieren,​ Encoding festlegen*/ /* Initialisierung:​ WSDL-Datei angeben, Caching deaktivieren,​ Encoding festlegen*/
Zeile 204: Zeile 210:
                          );                          );
 </​code>​ </​code>​
-<​code>/​* Login: Mit eMail, Passwort. SoapFaults auf 1 setzen*/+ 
 +<​code>​ 
 +/* Login: Mit eMail, Passwort. SoapFaults auf 1 setzen*/
 $client->​login("​mymail@myhost.de","​meinpasswort",​1);​ $client->​login("​mymail@myhost.de","​meinpasswort",​1);​
 </​code>​ </​code>​
-<​code>/​* Fahrzeug ermitteln, Preis berechnen und Ergebnis formatiert ausgeben...*/​+ 
 +<​code>​ 
 +/* Fahrzeug ermitteln, Preis berechnen und Ergebnis formatiert ausgeben...*/​
 print_r($client->​calcCar("​0999", ​               /* HSN */ print_r($client->​calcCar("​0999", ​               /* HSN */
                          "​269", ​                /* TSN */                          "​269", ​                /* TSN */
Zeile 241: Zeile 251:
 ?> ?>
 </​code>​ </​code>​
 +
 Ergibt folgende Ausgabe: Ergibt folgende Ausgabe:
  
-<​code>​Array+<​code>​ 
 +Array
 ( (
     [0] => Array     [0] => Array
Zeile 250: Zeile 262:
             [model] => C-Klasse             [model] => C-Klasse
             [submodelName] => Modell ab 2004 (W203 Facelift)             [submodelName] => Modell ab 2004 (W203 Facelift)
-            [buildKind] => 2+            [buildKind] => KOMBI
             [specialModel] => Classic             [specialModel] => Classic
             [power] => 110             [power] => 110
             [doorCount] => 5             [doorCount] => 5
             [color] =>             [color] =>
-            [fuel] => 2+            [fuel] => DIESEL
             [packets] => Array             [packets] => Array
                 (                 (
Zeile 420: Zeile 432:
 ) )
 </​code>​ </​code>​
 +
 An der Ausgabe ist zu erkennen, dass zunächst Marke, Modell und Submodell anhang der HSN/TSN erkannt und zugeordnet An der Ausgabe ist zu erkennen, dass zunächst Marke, Modell und Submodell anhang der HSN/TSN erkannt und zugeordnet
 wurden. Die Farbe wurde automatisch anhand des Freitextes erkannt. Das Paket "​Sport"​ wurde auch am Freitext erkannt. wurden. Die Farbe wurde automatisch anhand des Freitextes erkannt. Das Paket "​Sport"​ wurde auch am Freitext erkannt.
dokumentation_der_soap_schnittstelle_version_3.0.1523466078.txt.gz · Zuletzt geändert: 2018-04-11 19:01 von admin