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
| Parameter | Bezeichnung | Bemerkung |
|---|---|---|
| aktion | Gibt die Aktion an | Pflichtparameter. Ist fix “einbuchen”. |
| klasse_id | Buchungsklasse | Pflichtparameter. Erhält man vom Anbieter, z.B. 1 |
| tarif_id | ID des Tarifs. | Pflichtparameter. Erhält man vom Anbieter, z.B. 1 |
| waehrung_id | ID der Währung | Pflichtparameter. 1 für EUR |
| aktion_id | ID einer Sonderaktion | Optional |
| buchungscode | Buchungsnummer, die auf dem externen System erzeugt wird. | Optional. Varchar. |
| verkaufsstelle_id | ID der Verkaufsstelle | Optional |
| user_id | Benutzer-ID des Anlage-Users | Optional, z.B. die ID eines Mitarbeiters. |
| token | XML-Token | Wird vom Anbieter bereitgestellt. Pflichtparameter |
| handy_nr | Handy-Nr des Kunden | Optional |
| temp | Angabe ob temporäre Buchung | 1 für true, 0 für false |
| zahlart_id | ID der Zahlart | Pflichtparameter. Erhält man vom Anbieter. |
| linie_id | ID der Linie für die Hinfahrt | Optional wenn linie_hafen_fahrplan_id |
| rueckfahrt_linie_id | ID der Zahlart | Optional wenn die Rückfahrt angelegt wurde |
| datum_hinfahrt | Datum der Hinfahrt | Pflichtparameter. Im Format dd.mm.yyyy |
| rueckfahrt | Angabe ob einfache Fahrt- oder Hin-und Rückfahrt | Pflichtparameter. 1 für nur Hinfahrt, 2 für Hin- und Rückfahrt |
| datum_rueckfahrt | Datum der Rückfahrt | Pflichtparameter wenn Rückfahrt gewählt. Im Format dd.mm.yyyy |
| datum_hinfahrt_uhrzeit | Uhrzeit der Hinfahrt | Optional. Uhrzeit der Rückfahrt mm:hh |
| datum_rueckfahrt_uhrzeit | Uhrzeit der Rückfahrt | Optional. Uhrzeit der Rückfahrt mm:hh |
| hafen_umstieg_id | ID der Station bei Umstiegsverbindungen. | Optional. Das System sucht dann die passenden Fahrten und bucht die Verbindung entsprechend ein. |
| data | JSON Array mit den gewählten Positionen | Pflichtangabe. 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
| Parameter | Bezeichnung | Bemerkung |
|---|---|---|
| typ | Angabe des Positionstyps. | Pflichtangabe.Preistyp: preistypAusstattung: ausExtra / Zusatz: extra |
| ds_id | ID des Datensatzes | |
| anzahl | Pflichtangabe. Anzahl der Positionen | |
| bezeichnung | Pflichtangabe. Bezeichnung der Position | |
| einzelbetrag | Pflichtangabe. Brutto-Einzelbetrag der Position | |
| mwst_satz | Pflichtangabe. 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 |