POST pkwlabel
Achtung: veraltete API Definition – neue Dokumentation unter:
|
PKW-Label Beispiel
Mit Hilfe der pkwlabel Resource wird ein PKW Label on-the-fly mit den angelieferten Werten erstellt und angezeigt. Die Ausgabe kann dann vom anfragenden System entsprechend gespeichert und weiterverarbeitet werden.
Wichtiger Hinweis
Eine Überprüfung der angelieferten Felder ist nur bedingt möglich. Der Datenlieferant / API Nutzer ist selbst für die Richtigkeit der ins PDF eingefügten Werte verantwortlich.
Resource URL
https://envkv.54grad.de/api/pkwlabel
Parameter
POST Parameter mit dem Hinweis „required“ sind zwingend mit gültigen Daten zu übermitteln, da es sonst zu einem Abbruch der Berechnung kommen wird. „optional“ gekennzeichnete Parameter haben entweder einen Vorgabewert (Default) oder sind nur in bestimmten Konstellationen notwendig. Mehr Infos finden Sie in der jeweiligen Parameterbeschreibung und unter Antwort bei Fehlern.
| marke required |
string | Fahrzeug Hersteller Beispiel: Skoda |
| modell required |
string | Modell, Motor und Ausstattungsvariante Bezeichnung Beispiel: Octavia III 1.9 TDI Elegance |
| kw required |
int | Leistung des Motors in KW. Bei bivalenten Fahrzeugen die Leistung mit der Kraftstoffart mit dem geringsten CO2 Ausstoß. Beispiel: 84 |
| kw_bivalent optional |
int | Bei bivalenten Fahrzeugen die Leistung des Motors in KW mit der Kraftstoffart mit dem höheren CO2 Ausstoß. Wird dieser Wert bei bivalenten Fahrzeugen nicht geliefert, so wird das Feld kw erneut verwendet. Beispiel: 89 |
| kraftstoff required (ausser bei reinen Elektrofahrzeugen) |
string | Der vom Hersteller empfohlene Kraftstoff. Bei bivalenten Fahrzeugen die Kraftstoffart mit dem geringsten CO2 Ausstoß. Mögliche Kraftstoffe siehe: Energiekosten Default: – Beispiel: supere10 |
| kraftstoff_bivalent optional |
string | Bei bivalenten Fahrzeugen die Kraftstoffart mit dem höheren CO2 Ausstoß. Mögliche Kraftstoffe siehe: Energiekosten Beispiel: Super E10 |
| energieträger optional |
string | Auflistung anderer Energieträger (derzeit: Strom, Wasserstoff) Default: – Beispiel: Strom |
| masse required |
int | Masse des fahrbereiten Fahrzeuges in ganzen Kilogramm (COC) Achtung: nicht das Leergewicht verwenden! Beispiel: 1484 |
| co2 required |
int string |
Kombinierter CO2 Ausstoß in g/km. Bei bivalenten Fahrzeugen die Kraftstoffart mit dem geringsten CO2 Ausstoß. Bei Antrieben ohne CO2 Ausstoß als Wert ‘entfaellt’ verwenden, da der Wert 0 einen Fehler zurück gibt. Wichtig: siehe auch wltp_co2 Beispiel: 148 Beispiel: entfaellt |
| hubraum required (ausser bei reinen Elektrofahrzeugen) |
int | Größe des Hubraums in ccm Beispiel: 1998 |
| ez optional |
int | Tag der Erstzulassung als unixtimestamp Wert. Höhere Freigrenzen vor 2014 und 2011 und gestaffelte CO2 Besteuerung ab 01.01.2021. Beispiel: 1325289600 |
| verbrauch required (ausser bei reinen Elektrofahrzeugen) |
float | Kombinierter Kraftstoffverbrauch auf 100km. Bei bivalenten Fahrzeugen die Kraftstoffart mit dem geringsten CO2 Ausstoß. Default: – Beispiel: 7.2 |
| verbrauch_in required (ausser bei reinen Elektrofahrzeugen) |
float string |
Kraftstoffverbrauch innerorts auf 100km. Bei bivalenten Fahrzeugen die Kraftstoffart mit dem geringsten CO2 Ausstoß. Bei Hybridfahrzeugen muss ‚entfaellt‘ verwendet werden. Als Wert wird dann ‚entfällt‘ im PDF dargestellt. Default: – Beispiel: 9.3 |
| verbrauch_au required (ausser bei reinen Elektrofahrzeugen) |
float string |
Kraftstoffverbrauch außerorts auf 100km. Bei bivalenten Fahrzeugen die Kraftstoffart mit dem geringsten CO2 Ausstoß. Bei Hybridfahrzeugen muss ‚entfaellt‘ verwendet werden. Als Wert wird dann ‚entfällt‘ im PDF dargestellt. Default: – Beispiel: 5.1 |
| verbrauch_strom optional |
float | Stromverbrauch in kWh/100km. Default: – Beispiel: 13.5 |
| wltp_slow optional |
float | Kraftstoffverbrauch langsam nach WLTP Default: – Beispiel: 4.7 |
| wltp_average optional |
float | Kraftstoffverbrauch mittel nach WLTP Default: – Beispiel: 5.2 |
| wltp_fast optional |
float | Kraftstoffverbrauch schnell nach WLTP Default: – Beispiel: 6.9 |
| wltp_very_fast optional |
float | Kraftstoffverbrauch sehr schnell nach WLTP Default: – Beispiel: 7.8 |
| wltp_combined optional |
float | Kraftstoffverbrauch kombiniert nach WLTP Default: – Beispiel: 5.7 |
| wltp_co2 optional |
int | Kombinierter CO2 Ausstoß in g/km nach WLTP Sofern vorhanden, muss dieser Wert für die Steuerberechnung verwendet werden. Für das PKW Label selbst muss noch der alte CO2 Wert verwendet werden, da hier die Gesetzesänderung noch aussteht. Default: – |
| hide_wltp_infopage optional |
bool | Soll die extra WLTP Infosseite ausgeblendet werden? Wenn das PKW Label an ein bestehendes Angebot angehängt werden soll, dann ist die Infoseite manchmal nicht notwendig, da diese Infos bereits im Angebot beinhaltet sind. Default: false Beispiel: TRUE |
| creator optional |
string | Ersteller Angabe links unten Default: – (wird nicht angezeigt) Beispiel: Autohaus Test GmbH Hinweis: Ersteller ist das Unternehmen, welches das PDF verwendet, nicht eventuelle Zwischendienstleister oder die PKW Label API selbst. |
Hinweis: Bei der Angabe der neuen WLTP Werten wird eine Extraseite mit gesetzlichen Hinweisen und den WLTP Infos hinzugefügt. Diese dient der Kundeninformation. So lange die PKW Label Gesetzgebung noch nicht geändert ist, muss weiterhin der alte CO2 Wert für die Effizienzberechnung herangezogen werden. Die Steuerberechnung allerdings soll sich ab sofort schon auf den WLTP CO2 beziehen und ist für Neuwagen Pflicht.
Update: Bei Angeboten, die nur noch WLTP Verbrauchswerte ausgewiesen haben, sind die Felder co2 und alle verbrauch Felder NICHT zu übertragen. Die wltp_ Werte müssen vorhanden sein. Dann erkennt das System eine Bearbeitung nur mit WLTP Werten und erstellt ein gesetzlich vorgeschriebenes PKW Label mit den ausweisbaren Daten aber ohne Effizienzklasse.
PKW-Label an bestehendes PDF anhängen
Sofern eine PDF-Datei in der POST-Anfrage mitgesendet wird, so wird das PKW-Label als letzte Seite an das bestehende PDF angehängt und als Gesamtdatei wieder ausgegeben. So können Sie z.B. an Ihre Angebote direkt das PKW-Label anhängen und die Datei im eigenen System aktualisieren.
Es kann nur eine Datei mit upgeloaded werden und das Format (MimeType) muss application/pdf entsprechen. Andere Dateien oder Anfragen mit mehreren Uploads werden ignoriert.
Beispiel Anfrage
| POST |
https://envkv.54grad.de/api/pkwlabel |
| POST-Data |
marke=Skoda&modell=Octavia+III+1%2C6+TDI+CR+77kW+DSG+ Elegance+Plus&kw=84&kraftstoff=Diesel&verbrauch=7.9 &verbrauch_in=9.3&verbrauch_au=5.1&masse=1484 &co2=142&hubraum=1998 |
| Antwort |
Content-type: application/pdf Beispiel: pkwlabel.pdf |
Plausibilitätsprüfung
Folgende Bedingungen werden vor der Erstellung geprüft und führen bei Fehlern zum Abbruch (siehe „Antwort bei Fehlern“).
- Verbrauchswerte werden möglichst in einen Float Wert umgewandelt, so dass auch ein gelieferter String ‚7,3‘ als Float 7.3 verwendet werden kann
- Es fehlt einer dieser Parameter: marke, modell, kw, masse, co2
- Es fehlt der verbrauch oder hubraum, ausser es ist ein reines Elektrofahrzeug
- Wird ein verbrauch angegeben, so muss kraftstoff einen gültigen Wert aus der Energiekosten Liste enthalten
- Wird ‚Strom‘ als energietraeger angegeben, muss ein Wert für verbrauch_strom vorhanden sein
- Ist ‚wltp_co2‘ vorhanden, so wird dieser Wert für die Steuerberechnung verwendet und im PKW Label extra gekennzeichnet
- Sind mindestens ‚wltp_co2‘ oder ‚wltp_average‘ vorhanden, so wird eine weitere Infoseite mit WLTP Hinweisen erzeugt
Antwort bei Fehlern
Sollte es zu Fehlern bei der Verarbeitung kommen, wird das Feld ’status‘ der JSON Antwort die Fehlermeldung enthalten. Der gesendete HTTP-Response-Header ist dann 400.
| Antwort |
{
"statuscode":400,
"status":"Es fehlen wichtige Grundwerte
zur Erstellung des PKW Labels."
}
|
EnVKV API Grundlagen
Weitere Informationen entnehmen Sie bitte der Hauptübersicht: API Grundlagen