Bereitstellungsanzeige

auf Interex Briefpapier

Mit Hilfe der bereitstellungsanzeige Resource wird ein Anschreiben zur Benachrichtiung des Kunden über das bevorstehende Eintreffen des bestellten Fahrzeuges mit mehreren Textbausteinen je nach Abhol-, Zulassungs- und Bezahlungsform erstellt.

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, POST

http://envkv.54grad.de/pdf/bereitstellungsanzeige

Parameter

POST Parameter mit dem Hinweis „required“ sind zwingend mit gültigen Daten zu übermitteln, da es sonst zu einem Abbruch der Generierung kommen wird. Andere 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.

use_company_background bool
string
Benutze die hinterlegte Briefpapier Vorlage, z.B. für den Druck auf weißem Papier oder dem Versand per Email.
Default: false
Beispiel: true
addressee
required
string Vollständige Anschrift
Beispiel:
Max Mustermann
Musterstraße 1
12345 Musterstadt
salutation string Anrede inkl. Name
Default: Sehr geehrte Damen und Herren
Beispiel: Sehr geehrter Herr Vogt
deliverytime
required
string Zeitpunkt der Bereitstellung bzw. Verfügbarkeit.
Mögliche Werte: now, week, date
Default: now
Beispiel: date
deliverytime_week
(bei deliverytime: week)
int Lieferwoche, wenn deliverytime week ist.
Beispiel: 49
deliverytime_year
(bei deliverytime: week)
int Lieferjahr, wenn deliverytime week ist.
Beispiel: 2017
deliverytime_datetext
(bei deliverytime: date)
string Genaues Lieferdatum, wenn deliverytime date ist.
Beispiel: 02.05.2017, 17.00 Uhr
pickup_location string Fahrzeug Standort. Es wird ein „bei“ vorangestellt.
Beispiel: Autohaus Interex
Beispiel: uns
pickup_location string Standort Stadt. Es wird ein „in“ vorangestellt.
Beispiel: Deizisau
type_of_pickup string Wer holt das Fahrzeug ab bzw. wer liefert. Mögliche Werte:
customer
Kunde kommt persönlich
customer_send
Kunde bevollmächtigt einen Dritten
vendor_self
Wir liefern direkt auf Achse an
customer_carrier
Spedition (beauftragt von Kunde)
vendor_carrier
Spedition (beauftragt von uns)
Default: allgemeiner Textbaustein
Beispiel: customer
type_of_delivery string Wie wird das Fahrzeug übernommen. Mögliche Werte:
temporary_license_plate
mit Überführungskennzeichen
license_plate
mit endgültig zugelassenen Kennzeichen
export_license_plate
mit Exportkennzeichen
Default: allgemeiner Textbaustein
Beispiel: license_plate
payment string Wie erfolgt die Bezahlung. Mögliche Werte:
cash
Zahlung bei Abholung in bar
cheque
Zahlung bei Abholung per Scheck
advance_transfer
Zahlung vorab per Überweisung
Default: allgemeiner Textbaustein
Beispiel: cash
signing_employee_name string Unterzeichnender Mitarbeiter
Beispiel: Max Mustermann

Beispiel Anfrage

POST
http://envkv.54grad.de/pdf/bereitstellungsanzeige
POST-Data
addressee=Max%20Mustermann%0AMusterstra%C3%9Fe
%201%0A12345%20Musterstadt&deliverytime=now
Antwort
Content-type: application/pdf

Plausibilitätsprüfung

Teilweise sind Textblöcke von anderen Feldern abhängig, so dass sinnvolle Texte entstehen.

  • Bei Speditionslieferung wird bei der Bezahlung immer Vorab Überweisung verlangt.
  • Bei unbekannter Übernahme fließt die Abholart mit ein.

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: adressee, deliverytime"
}

EnVKV API Grundlagen

Weitere Informationen entnehmen Sie bitte der Hauptübersicht: API Grundlagen