Die Buchungs-API

Alle Calls der Buchungs-Api werden an xml.php gesandt.

Direkt einbuchen

Um eine Fahrt direkt einzubuchen, werden diese Parameter mit einem POST-Call übergeben

ParameterBezeichnungBemerkung
aktionGibt die Aktion anPflichtparameter. Ist fix "einbuchen".
klasse_idBuchungsklassePflichtparameter. Erhält man vom Anbieter, z.B. 1
tarif_idID des Tarifs.Pflichtparameter. Erhält man vom Anbieter, z.B. 1
waehrung_idID der WährungPflichtparameter. 1 für EUR
aktion_idID einer SonderaktionOptional
buchungscodeBuchungsnummer, die auf dem externen System erzeugt wird.Optional. Varchar.
verkaufsstelle_idID der VerkaufsstelleOptional
user_idBenutzer-ID des Anlage-UsersOptional, z.B. die ID eines Mitarbeiters.
tokenXML-TokenWird vom Anbieter bereitgestellt. Pflichtparameter
handy_nrHandy-Nr des KundenOptional
tempAngabe ob temporäre Buchung1 für true, 0 für false
zahlart_idID der ZahlartPflichtparameter. Erhält man vom Anbieter.
linie_idID der Linie für die HinfahrtOptional wenn linie_hafen_fahrplan_id
rueckfahrt_linie_idID der ZahlartOptional wenn die Rückfahrt angelegt wurde
datum_hinfahrtDatum der HinfahrtPflichtparameter. Im Format dd.mm.yyyy
rueckfahrtAngabe ob einfache Fahrt- oder Hin-und RückfahrtPflichtparameter. 1 für nur Hinfahrt, 2 für Hin- und Rückfahrt
datum_rueckfahrtDatum der RückfahrtPflichtparameter wenn Rückfahrt gewählt. Im Format dd.mm.yyyy
datum_hinfahrt_uhrzeitUhrzeit der HinfahrtOptional. Uhrzeit der Rückfahrt mm:hh
datum_rueckfahrt_uhrzeitUhrzeit der RückfahrtOptional. Uhrzeit der Rückfahrt mm:hh
hafen_umstieg_idID der Station bei Umstiegsverbindungen.Optional. Das System sucht dann die passenden Fahrten und bucht die Verbindung entsprechend ein.
dataJSON Array mit den gewählten PositionenPflichtangabe. Als JSON-String übergeben, die API decodiert anschließend den String.

Aufbau des data JSON Arrays

In data sind die einzelnen Positionen zu der Buchung enthalten

ParameterBezeichnungBemerkung
typAngabe des Positionstyps.Pflichtangabe.
  • Preistyp: preistyp
  • Ausstattung: aus
  • Extra / Zusatz: extra
ds_idID des Datensatzes
anzahlPflichtangabe. Anzahl der Positionen
bezeichnungPflichtangabe. Bezeichnung der Position
einzelbetragPflichtangabe. Brutto-Einzelbetrag der Position
mwst_satzPflichtangabe. MwSt. Satz, z.B: 19 für 19%

Der Aufruf gibt ein JSON Objekt mit FALSE zurück wenn die Eintragung nicht erfolgreich war, beispielsweise wurden die Plätze mittlerweile andersweitig geblockt. Es wird TRUE und die Reservierung-ID zurückgegeben, wenn die Reservierung erfolgreich war.

Beispielaufruf

Der Beispielaufruf zeigt die Parameter der Buchung mit Beispielwerten.

Parameter Beispielwert
aktion einbuchen
aktion_id 0
buchungscode 0815ABCDEFG
data [{"typ":"preistyp","ds_id": 1,"anzahl":3,"bezeichnung":"Erwachsener","einzelbetrag":29.4,"mwst_satz":0},{"typ":"aus","ds_id": 1,"anzahl":2,"bezeichnung":"Fahrrad","einzelbetrag":0,"mwst_satz":0},{"typ":"gesamt","betrag":88.20}]
datum_hinfahrt 23.02.2015
datum_rueckfahrt 23.02.2015
drucker_id 1
hafen_start_id 1
hafen_stop_id 7
hafen_umstieg_id 0
handy_nr  
klasse_id 1
linie_id 2
rueckfahrt_linie_id (optional) 3
linie_hafen_fahrplan_id 2322
preis_drucken 1
rueckfahrt 2
tarif_id 1
user_id 1
verkaufsstelle_id 1
waehrung_id 1
zahlart_id 4

Stornieren

Eine Buchung kann im System mit dem Storno-Aufruf storniert werden. Die Parameter werden als GET übergeben.

Parameter Wert
aktion storno
token Der Token für den Zugang zum System
reservierung_id ID der Reservierung

Als Rückgabe erhält man ein JSON Array mit success true / false

Temporäre Buchung in reguläre Buchung ändern

Die Buchung wird von Temporär in Regulär geändert.

Parameter Wert
aktion temp2regular
token Der Token für den Zugang zum System
reservierung_id ID der Reservierung

Stationsliste anfordern

Parameter Wert
aktion stationen
token Der Token für den Zugang zum System
only_station_id_id Nur die Informationen für eine Station herausfinden

Beispiel Onlinedemo: Stationsliste laden

Als Rückgabe erhält man ein JSON Array mit der Stationsliste und den dazugehörigen Feldern

Wegweiser