Webservice-Schnittstelle

Die Webservice-Schnittstelle richtet sich an technisch versierte  Betreiber von Webseiten, die automatisiert zahlreiche URLs generieren möchten. Alternativ kannst du natürlich jederzeit Einzellinks generieren.

Es handelt sich um eine JSON-Schnittstelle, über die Text-Links generiert werden können. Es wird eine reine URL zurückgegeben. Die Schnittstelle erwartet und liefert Daten im Zeichensatz UTF-8.

Auf Anfrage senden wir dir gerne das hvv Logo zu, wenn du den Link zur hvv Fahrplanauskunft prominenter hervorheben möchtest. Bitte schicke uns dazu eine Anfrage mit einer kurzen Beschreibung deines Vorhabens.

Wenn zu einem angefragten Wert kein eindeutiges Ergebnis gefunden werden konnte, wird eine Liste von Vorschlägen zurückgegeben, die aus maximal 20 Einträgen besteht. Über diese Vorschläge kann die Suchanfrage spezifiziert werden.

Die Webservice-Methode erwartet folgende Werte:

Erfolgsfall

Der Wert des Feldes „url“ ist die Antwort auf die Anfrage und kann auf der Webseite eingesetzt werden.

Als zusätzliche Information wird der Startpunkt (falls angefragt) und das Ziel der generierten Verlinkung zurückgegeben.

Fehlerfälle

Fehler die nicht zur Generierung eines Links führen, werden ausschließlich durch SOAP Faults behandelt.
Nachfolgend sind alle auftretenden Fehlerfälle aufgeführt:

Technische Fehler

In der technischen Dokumentation kann mit Hilfe der "Try it out"-Funktion eine Beispiel-Anfrage gebaut und getestet werden, welche dann die Grundlage für Entwicklungen bilden kann.