Documentatie
difficulty level:
API - Event - POST event/subscribe
POST event/subscribe
Verwendet für
Hinzufügen einer Buchung für ein bestimmtes Event. Dasselbe kann über die API zum Hinzufügen einer Buchung erreicht werden. Für Events ist diese Methode jedoch einfacher.
Authentifizierung
Anonymer Zugriff ist erlaubt. Bei anonymem Zugriff ist eine Aktualisierung der customer id nicht erlaubt.
Wenn der Benutzer angemeldet ist, hängt es von den Berechtigungen ab. Erstellen einer Buchung:
- entity_booking_create_own - bedeutet, dass der Benutzer eine Buchung für einen Kunden erstellen darf, der dem aktuell angemeldeten Benutzer gehört
- entity_booking_create_owngroup - bedeutet, dass der Benutzer eine Buchung für einen Kunden erstellen darf, der zur aktuell angemeldeten Benutzergruppe gehört
- entity_booking_create_other - bedeutet, dass der Benutzer eine Buchung für Kunden in anderen Gruppen erstellen darf
- entity_booking_create_all - bedeutet, dass der Benutzer eine Buchung für alle Kunden erstellen darf
- Das Aktualisieren eines Kunden erfordert - entity_customer_update
- Das Erstellen eines Kunden erfordert - entity_customer_create
- Das Aktualisieren eines anderen Kunden als des angemeldeten Benutzers - bedeutet, dass der Benutzer die Berechtigung benötigt: entity_customer_update_other
Parameter
| Parameter | Beschreibung | Erforderlich | Beispiel |
|---|---|---|---|
| event_id | Event-ID der Buchung | Ja | 2012-08-08_1 |
| customer | Kunden-objekt kann angegeben werden Wenn customer_id angegeben ist, wird die Buchung mit diesem bestehenden Kunden verknüpft |
Nein | |
| options | Ein Array von Optionen, jeweils in Kombination aus option_name und der erforderlichen Anzahl | Nein | |
| participants | Ein Array von Teilnehmern, jede Kombination enthält mindestens die participant_id und optionale Teilnehmerfelder | Nein | |
| voucher | Ein Array von Gutscheincodes. Nur gültige Codes werden verwendet. Für ungültige Codes wird kein Feedback gegeben. |
Nein | VALIDVOUCHER1,VALIDVOUCHER2,INVALIDVOUCHER |
| customX | Ein benutzerdefiniertes Buchungsfeld, ersetzen Sie x durch die Nummer des Feldes. D.h. "custom01" ist der Name des ersten benutzerdefinierten Feldes. Verwenden Sie den Rohwert zum Posten des Wertes bei benutzerdefinierten Tabellen. Kann nur gesetzt werden, wenn es sich um ein optionales oder erforderliches Feld handelt. |
Nein |
Beispiel
Hinzufügen einer Buchung für 3 Personen (in diesem Fall 2 Erwachsene und 1 Kind). Fügen Sie einen neuen Kunden hinzu und fügen Sie eine Option hinzu.
POST api/rest/event/subscribe
Request:
{
"event_id": "2012-08-08_1",
"customer": {
"lastname": "Demo"
},
"participants": [
{
"id": "1",
"lastname": "Ester"
},
{
"id": "1",
"lastname": "Ester"
},
{
"id": "2",
"lastname": "Ester"
}
],
"options": [
{
"Bierpakket": "1"
}
],
"voucher":"VALIDVOUCHER1,VALIDVOUCHER2,INVALIDVOUCHER"
}
Response:
{
"status": true,
"booking_id": 40690,
"messages": [
"Booking made"
]
}
