Anmelden um den Slug und den veröffentlichbaren Schlüssel Ihrer Location in jedem Beispiel zu sehen.
Ihr Konto hat noch keine Location, die Beispiele behalten daher ihre Platzhalter. Abmelden
Angemeldet als · . Legen Sie in der Konsole einen veröffentlichbaren Schlüssel an und laden Sie die Seite neu, um ihn hier zu sehen. Abmelden
Angemeldet als · . Die Beispiele zeigen den veröffentlichbaren Schlüssel Ihrer Location. Abmelden
Entwicklerdokumentation
Endpunkt-Referenz
Jede öffentliche API-Route mit Parametern, Feldern, Typen und Grenzen, erzeugt aus dem OpenAPI-Dokument, mit Ausprobieren-Formular für lesende Routen.
So nutzen Sie diese Seite
Diese Seite wird aus dem OpenAPI-Dokument der API selbst erzeugt und listet deshalb genau die Routen, die die API anbietet, und nichts sonst: Eine in der API hinzugefügte, entfernte oder umbenannte Route erscheint mit dem nächsten Release hier, und eine Build-Prüfung schlägt fehl, bis es so weit ist. Routenpfade, Feldnamen und Schemanamen stehen in jeder Sprache so, wie die API sie schreibt.
Nutzen Sie sie neben den Anleitungsseiten: Diese erklären das Verhalten und enthalten Anfragebeispiele in cURL, JavaScript, C# und PHP, diese Seite ist die vollständige Liste dessen, was Sie senden können. Jede Route verlinkt auf ihren Abschnitt in der Anleitung, soweit es einen gibt, und jede Ablehnung verlinkt auf ihre Erklärung auf der Fehlerseite.
Zwei Dinge unterscheiden die Ausprobieren-Formulare vom Rest der Doku. Sie senden eine echte Anfrage aus Ihrem Browser an https://api.bookdineplay.com, gegen die fiktive Demo-Location demo-sportsbar, mit einem veröffentlichbaren Demo-Schlüssel, den man gefahrlos zeigen darf. Und es gibt sie nur für lesende Routen: Alles, was Daten anlegen oder ändern würde, etwa eine Buchung, wird mit seinen Feldern gezeigt und von hier aus nie gesendet. Basis-URL, Header, Datums- und Zeitzonenregeln stehen in der API-Übersicht.
Öffentliche Endpunkte
Jede Route, die ein Widget, ein SDK oder das Gerät eines Gasts aufrufen darf, erzeugt aus dem OpenAPI-Dokument der API. Routen unter /api/venues/** brauchen einen API-Schlüssel; die übrigen tragen ihr Credential in der URL.
GET /api/venues
Braucht einen API-Schlüssel in X-BookDinePlay-Key oder Authorization: Bearer. Ein veröffentlichbarer Schlüssel muss von einem erlaubten Origin kommen; ein geheimer Schlüssel darf keinen Origin senden.
Anleitung und Beispiele: Location-Verzeichnis
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
query | query | string | Nein | – | – |
city | query | string | Nein | – | – |
page | query | integer (int32) | Nein | – | – |
pageSize | query | integer (int32) | Nein | – | – |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:
missing-api-keyinvalid-api-keyplatform-key-requiredorigin-not-allowedapp-key-from-browserrate-limited
Kein „Ausprobieren“: Das Location-Verzeichnis antwortet nur auf BookDinePlays eigene Plattform- und App-Schlüssel, nie auf den veröffentlichbaren Schlüssel einer Location.
GET /api/venues/{venueSlug}
Braucht einen API-Schlüssel in X-BookDinePlay-Key oder Authorization: Bearer. Ein veröffentlichbarer Schlüssel muss von einem erlaubten Origin kommen; ein geheimer Schlüssel darf keinen Origin senden.
Anleitung und Beispiele: Profil
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
venueSlug | path | string | Ja | – | – |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:
GET /api/venues/{venueSlug}/availability
Braucht einen API-Schlüssel in X-BookDinePlay-Key oder Authorization: Bearer. Ein veröffentlichbarer Schlüssel muss von einem erlaubten Origin kommen; ein geheimer Schlüssel darf keinen Origin senden.
Anleitung und Beispiele: Verfügbarkeit
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
venueSlug | path | string | Ja | – | – |
date | query | string | Ja | – | – |
partySize | query | integer (int32) | Nein | – | Standard 2 |
resourceType | query | BookableResourceType | Nein | – | Standard RestaurantTableeiner von: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar |
durationMinutes | query | integer (int32) | Nein | – | – |
groupBy | query | string | Nein | – | – |
resourceGroup | query | string (uuid) | Nein | – | – |
children | query | integer (int32) | Nein | – | Standard 0 |
includePreviousNight | query | boolean | Nein | – | Standard false |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:
GET /api/venues/{venueSlug}/business-info
Braucht einen API-Schlüssel in X-BookDinePlay-Key oder Authorization: Bearer. Ein veröffentlichbarer Schlüssel muss von einem erlaubten Origin kommen; ein geheimer Schlüssel darf keinen Origin senden.
Anleitung und Beispiele: Geschäftsdaten
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
venueSlug | path | string | Ja | – | – |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:
GET /api/venues/{venueSlug}/floor-plan
Braucht einen API-Schlüssel in X-BookDinePlay-Key oder Authorization: Bearer. Ein veröffentlichbarer Schlüssel muss von einem erlaubten Origin kommen; ein geheimer Schlüssel darf keinen Origin senden.
Anleitung und Beispiele: Raumplan
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
venueSlug | path | string | Ja | – | – |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:
GET /api/venues/{venueSlug}/menus
Braucht einen API-Schlüssel in X-BookDinePlay-Key oder Authorization: Bearer. Ein veröffentlichbarer Schlüssel muss von einem erlaubten Origin kommen; ein geheimer Schlüssel darf keinen Origin senden.
Anleitung und Beispiele: Speisekarten
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
venueSlug | path | string | Ja | – | – |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:
GET /api/venues/{venueSlug}/opening-hours
Braucht einen API-Schlüssel in X-BookDinePlay-Key oder Authorization: Bearer. Ein veröffentlichbarer Schlüssel muss von einem erlaubten Origin kommen; ein geheimer Schlüssel darf keinen Origin senden.
Anleitung und Beispiele: Öffnungszeiten
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
venueSlug | path | string | Ja | – | – |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:
POST /api/venues/{venueSlug}/payment-intents
Braucht einen API-Schlüssel in X-BookDinePlay-Key oder Authorization: Bearer. Ein veröffentlichbarer Schlüssel muss von einem erlaubten Origin kommen; ein geheimer Schlüssel darf keinen Origin senden.
Anleitung und Beispiele: Payment Intents
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
venueSlug | path | string | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
reservationReference | string | Ja | – | – | |
amount | number (double) | Ja | – | min. 0.01 max. 100000 Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
currency | string | Ja | – | Länge 3–3 | |
provider | string | Nein | Ja | – | Optional provider key. Only the local "fake" provider is available in the first milestone. |
voucherCode | string | Nein | Ja | max. 64 Zeichen | A gift voucher of this venue to pay the deposit with, fully or partly (#321). When present, decimal CreatePaymentIntentRequest.Amount must equal the booking's deposit; the voucher pays what it covers (an amount voucher only — a percentage or item voucher is refused with voucher-not-applicable) and the card pays the rest. A voucher that covers everything opens no card payment at all: the response's string? PaymentIntentResponse.CheckoutUrl is then the booking's success page. The code is a bearer credential — send it in this body only, never in a URL. |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:
missing-api-keyinvalid-api-keyvenue-mismatchorigin-not-allowedsecret-key-from-browserpublishable-key-without-originapp-key-from-browser
Nur Beispiele: Diese Route legt Daten an oder ändert sie, deshalb sendet die Referenz sie nie. Anfragebeispiele stehen in der Anleitung oben.
POST /api/venues/{venueSlug}/reservations
Braucht einen API-Schlüssel in X-BookDinePlay-Key oder Authorization: Bearer. Ein veröffentlichbarer Schlüssel muss von einem erlaubten Origin kommen; ein geheimer Schlüssel darf keinen Origin senden.
Anleitung und Beispiele: Reservierungen
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
venueSlug | path | string | Ja | – | – |
Idempotency-Key | header | string | Nein | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
resourceType | BookableResourceType | Ja | – | einer von: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar | The kinds of bookable resource a venue can publish. A restaurant table booking uses the same reservation model as a billiard or dart booking; only the type and pricing rules differ. |
resourceId | string | Nein | Ja | – | Optional specific resource id. When omitted the service picks the first available resource of the type. |
date | string | Ja | – | – | Venue-local date, "yyyy-MM-dd". |
start | string | Ja | – | – | Venue-local start time, "HH:mm". |
end | string | Nein | Ja | – | Optional venue-local end time, "HH:mm". Defaults to the resource slot length. |
partySize | integer (int32) | Ja | – | min. 1 max. 200 | |
games | integer (int32) | Nein | Ja | min. 1 max. 10 | How many games to book, for resources priced per game. Defaults to 1 when omitted. |
customerName | string | Ja | – | Länge 2–120 | |
email | string | Ja | – | max. 256 Zeichen | Bounded by int FieldLengths.Email — the same constant the Reservations.Email column is configured with. Without it this was unbounded from the public widget, and a long address reached SQL Server as error 2628 (issue #127). |
phone | string | Nein | Ja | Länge 3–40 | Optional. 3–40 characters when supplied; blank is treated as not supplied. |
notes | string | Nein | Ja | max. 500 Zeichen | |
depositOptIn | boolean | Nein | – | – | Whether the guest opts in to an optional deposit (only offered when the venue enables deposits). |
extras | array of ExtraSelectionDto | Nein | Ja | – | Optional extras the guest wants added to the booking, e.g. shoe rental. |
extras[].extraId | string | Ja | – | – | |
extras[].quantity | integer (int32) | Ja | – | min. 1 max. 100 | |
durationMinutes | integer (int32) | Nein | Ja | min. 15 max. 1440 | Requested booking length in minutes. When omitted the venue's default for the resource type applies. Must be a duration the venue offers for that type, and the whole booking must fit inside the venue's opening hours. |
children | integer (int32) | Nein | Ja | min. 0 max. 199 | How many of int CreateReservationRequest.PartySize are children (issue #554). int CreateReservationRequest.PartySize stays the total head count and the only capacity input, so adults are PartySize - Children; at least one adult must remain. Omitted or null means no children. Refused while the venue has switched the "ask for children" setting off. |
highChairs | integer (int32) | Nein | Ja | min. 0 max. 199 | How many of the venue's high chairs / child seats the booking reserves (issue #555): 0 up to int? CreateReservationRequest.Children, and no more than the venue owns (VenueResponse.HighChairs) and has free in the booking's window. Omitted or null means none. |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:
missing-api-keyinvalid-api-keyvenue-mismatchorigin-not-allowedsecret-key-from-browserpublishable-key-without-originapp-key-from-browser
Nur Beispiele: Diese Route legt Daten an oder ändert sie, deshalb sendet die Referenz sie nie. Anfragebeispiele stehen in der Anleitung oben.
GET /api/venues/{venueSlug}/resources
Braucht einen API-Schlüssel in X-BookDinePlay-Key oder Authorization: Bearer. Ein veröffentlichbarer Schlüssel muss von einem erlaubten Origin kommen; ein geheimer Schlüssel darf keinen Origin senden.
Anleitung und Beispiele: Ressourcen
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
venueSlug | path | string | Ja | – | – |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:
GET /api/venues/{venueSlug}/events
Braucht einen API-Schlüssel in X-BookDinePlay-Key oder Authorization: Bearer. Ein veröffentlichbarer Schlüssel muss von einem erlaubten Origin kommen; ein geheimer Schlüssel darf keinen Origin senden.
Anleitung und Beispiele: Events
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
venueSlug | path | string | Ja | – | – |
upcoming | query | boolean | Nein | – | Standard true |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:
GET /api/venues/{venueSlug}/events/{eventSlug}
Braucht einen API-Schlüssel in X-BookDinePlay-Key oder Authorization: Bearer. Ein veröffentlichbarer Schlüssel muss von einem erlaubten Origin kommen; ein geheimer Schlüssel darf keinen Origin senden.
Anleitung und Beispiele: Events
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
venueSlug | path | string | Ja | – | – |
eventSlug | path | string | Ja | – | – |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:
POST /api/venues/{venueSlug}/events/{eventSlug}/registrations
Braucht einen API-Schlüssel in X-BookDinePlay-Key oder Authorization: Bearer. Ein veröffentlichbarer Schlüssel muss von einem erlaubten Origin kommen; ein geheimer Schlüssel darf keinen Origin senden.
Anleitung und Beispiele: Events
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
venueSlug | path | string | Ja | – | – |
eventSlug | path | string | Ja | – | – |
Idempotency-Key | header | string | Nein | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
buyerName | string | Ja | – | max. 120 Zeichen | |
email | string | Ja | – | max. 256 Zeichen | |
phone | string | Nein | Ja | max. 40 Zeichen | Optional. Blank is treated as not supplied. |
notes | string | Nein | Ja | max. 1000 Zeichen | |
quantity | integer (int32) | Ja | – | min. 1 max. 100 | How many tickets. Must not exceed the event's maxPerRegistration or its remaining capacity. |
attendees | array of string | Nein | – | – | Attendee names, one per ticket, in ticket order. The first may be blank (it defaults to string EventRegistrationRequest.BuyerName); every further ticket needs a name. Fewer entries than int EventRegistrationRequest.Quantity is a validation error for the missing tickets. |
children | integer (int32) | Nein | Ja | min. 0 max. 99 | How many of int EventRegistrationRequest.Quantity tickets are for children (issue #556), 0 up to int EventRegistrationRequest.Quantity minus 1: at least one adult ticket remains. Children pay the event's child ticket price when it has one. Omitted or null means none. |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:
missing-api-keyinvalid-api-keyvenue-mismatchorigin-not-allowedsecret-key-from-browserpublishable-key-without-originapp-key-from-browser
Nur Beispiele: Diese Route legt Daten an oder ändert sie, deshalb sendet die Referenz sie nie. Anfragebeispiele stehen in der Anleitung oben.
POST /api/venues/{venueSlug}/events/{eventSlug}/tickets/checkout
Braucht einen API-Schlüssel in X-BookDinePlay-Key oder Authorization: Bearer. Ein veröffentlichbarer Schlüssel muss von einem erlaubten Origin kommen; ein geheimer Schlüssel darf keinen Origin senden.
Anleitung und Beispiele: Events
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
venueSlug | path | string | Ja | – | – |
eventSlug | path | string | Ja | – | – |
Idempotency-Key | header | string | Nein | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
buyerName | string | Ja | – | max. 120 Zeichen | |
email | string | Ja | – | max. 256 Zeichen | |
phone | string | Nein | Ja | max. 40 Zeichen | Optional. Blank is treated as not supplied. |
notes | string | Nein | Ja | max. 1000 Zeichen | |
quantity | integer (int32) | Ja | – | min. 1 max. 100 | How many tickets. Must not exceed the event's maxPerRegistration or its remaining capacity. |
attendees | array of string | Nein | – | – | Attendee names, one per ticket, in ticket order. The first may be blank (it defaults to string EventTicketCheckoutRequest.BuyerName); every further ticket needs a name. Fewer entries than int EventTicketCheckoutRequest.Quantity is a validation error for the missing tickets. |
successUrl | string | Nein | Ja | – | Where the guest lands after paying. Must be https and either the calling API key's origin allowlist or the platform's own guest app; omitted uses the built-in registration page (/r/{cancelToken}). A URL that fails the check answers 400 naming the field (errors.successUrl). |
cancelUrl | string | Nein | Ja | – | Where the guest lands if they abandon Checkout. Same rule as string? EventTicketCheckoutRequest.SuccessUrl (errors.cancelUrl on failure). |
voucherCode | string | Nein | Ja | max. 200 Zeichen | Optional. A gift voucher of this venue to pay part or all of the tickets with (#322), in any form the voucher code parser accepts; the card pays whatever it leaves. Only money-value vouchers apply to tickets. When it covers everything, no payment page opens: checkoutUrl is the success page and amountDue is 0. Part of the request an Idempotency-Key guards. |
children | integer (int32) | Nein | Ja | min. 0 max. 99 | How many of int EventTicketCheckoutRequest.Quantity tickets are for children (issue #556), 0 up to int EventTicketCheckoutRequest.Quantity minus 1. Children pay the event's child ticket price when it has one; the card amount Stripe is asked for follows the split. Omitted or null means none. |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:
missing-api-keyinvalid-api-keyvenue-mismatchorigin-not-allowedsecret-key-from-browserpublishable-key-without-originapp-key-from-browser
Nur Beispiele: Diese Route legt Daten an oder ändert sie, deshalb sendet die Referenz sie nie. Anfragebeispiele stehen in der Anleitung oben.
GET /api/venues/{venueSlug}/specials
Braucht einen API-Schlüssel in X-BookDinePlay-Key oder Authorization: Bearer. Ein veröffentlichbarer Schlüssel muss von einem erlaubten Origin kommen; ein geheimer Schlüssel darf keinen Origin senden.
Anleitung und Beispiele: Specials
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
venueSlug | path | string | Ja | – | – |
date | query | string | Nein | – | – |
days | query | integer (int32) | Nein | – | Standard 1 |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:
POST /api/venues/{venueSlug}/vouchers/checkout
Braucht einen API-Schlüssel in X-BookDinePlay-Key oder Authorization: Bearer. Ein veröffentlichbarer Schlüssel muss von einem erlaubten Origin kommen; ein geheimer Schlüssel darf keinen Origin senden.
Anleitung und Beispiele: Gutscheine
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
venueSlug | path | string | Ja | – | – |
Idempotency-Key | header | string | Nein | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
productId | string | Ja | – | max. 32 Zeichen | The product to buy (string VoucherOfferDto.ProductId). |
amount | number (double) | Nein | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | A custom-amount product only: the value to buy, within its minimum and maximum. |
buyerName | string | Ja | – | max. 120 Zeichen | |
buyerEmail | string | Ja | – | max. 256 Zeichen | Where the receipt and — without a recipient e-mail — the voucher itself are sent. |
recipientName | string | Nein | Ja | max. 120 Zeichen | |
recipientEmail | string | Nein | Ja | max. 256 Zeichen | Sends the voucher to the recipient directly (on string? StartVoucherCheckoutRequest.DeliverOn, or at once). |
giftMessage | string | Nein | Ja | max. 500 Zeichen | |
deliverOn | string | Nein | Ja | – | yyyy-MM-dd, venue-local, from today to a year ahead: the day the recipient's e-mail is sent (at 09:00). Requires string? StartVoucherCheckoutRequest.RecipientEmail. |
language | string | Nein | Ja | – | "en" or "de": the voucher's and the e-mails' language. Defaults to the request's language. |
successUrl | string | Nein | Ja | – | Where the buyer lands after paying. Must be https and either the calling API key's origin allowlist or the platform's own guest app; omitted uses the built-in thank-you page. A URL that fails the check answers 400 naming the field. |
cancelUrl | string | Nein | Ja | – | Where the buyer lands if they abandon Checkout. Same rule as string? StartVoucherCheckoutRequest.SuccessUrl. |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:
missing-api-keyinvalid-api-keyvenue-mismatchorigin-not-allowedsecret-key-from-browserpublishable-key-without-originapp-key-from-browser
Nur Beispiele: Diese Route legt Daten an oder ändert sie, deshalb sendet die Referenz sie nie. Anfragebeispiele stehen in der Anleitung oben.
GET /api/venues/{venueSlug}/vouchers/offers
Braucht einen API-Schlüssel in X-BookDinePlay-Key oder Authorization: Bearer. Ein veröffentlichbarer Schlüssel muss von einem erlaubten Origin kommen; ein geheimer Schlüssel darf keinen Origin senden.
Anleitung und Beispiele: Gutscheine
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
venueSlug | path | string | Ja | – | – |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:
POST /api/event-registrations/{cancelToken}/cancel
Braucht keinen API-Schlüssel: Das Credential ist Teil der URL (ein QR-Token, Ticketcode, Storno-Token oder Gutscheincode, den der Gast erhalten hat).
Anleitung und Beispiele: Events
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
cancelToken | path | string | Ja | – | – |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt; die type-URL führt zur Erklärung. Alle Problemtypen.
Nur Beispiele: Diese Route legt Daten an oder ändert sie, deshalb sendet die Referenz sie nie. Anfragebeispiele stehen in der Anleitung oben.
GET /api/qr/{token}
Braucht keinen API-Schlüssel: Das Credential ist Teil der URL (ein QR-Token, Ticketcode, Storno-Token oder Gutscheincode, den der Gast erhalten hat).
Anleitung und Beispiele: QR-Codes und Tischsitzungen
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
token | path | string | Ja | – | – |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt; die type-URL führt zur Erklärung. Alle Problemtypen.
POST /api/qr/{token}/close
Braucht keinen API-Schlüssel: Das Credential ist Teil der URL (ein QR-Token, Ticketcode, Storno-Token oder Gutscheincode, den der Gast erhalten hat).
Anleitung und Beispiele: QR-Codes und Tischsitzungen
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
token | path | string | Ja | – | – |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt; die type-URL führt zur Erklärung. Alle Problemtypen.
Nur Beispiele: Diese Route legt Daten an oder ändert sie, deshalb sendet die Referenz sie nie. Anfragebeispiele stehen in der Anleitung oben.
POST /api/qr/{token}/orders
Braucht keinen API-Schlüssel: Das Credential ist Teil der URL (ein QR-Token, Ticketcode, Storno-Token oder Gutscheincode, den der Gast erhalten hat).
Anleitung und Beispiele: QR-Codes und Tischsitzungen
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
token | path | string | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
lines | array of OrderLineRequest | Ja | – | – | |
lines[].menuId | string | Ja | – | – | |
lines[].itemName | string | Ja | – | – | |
lines[].quantity | integer (int32) | Ja | – | – |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt; die type-URL führt zur Erklärung. Alle Problemtypen.
Nur Beispiele: Diese Route legt Daten an oder ändert sie, deshalb sendet die Referenz sie nie. Anfragebeispiele stehen in der Anleitung oben.
POST /api/qr/{token}/payment
Braucht keinen API-Schlüssel: Das Credential ist Teil der URL (ein QR-Token, Ticketcode, Storno-Token oder Gutscheincode, den der Gast erhalten hat).
Anleitung und Beispiele: QR-Codes und Tischsitzungen
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
token | path | string | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
voucherCode | string | Nein | Ja | max. 200 Zeichen | A gift voucher of the tab's venue to pay part or all of the tab with — as typed, pasted or scanned (any form the voucher code parser accepts). The card pays whatever the voucher leaves. |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt; die type-URL führt zur Erklärung. Alle Problemtypen.
Nur Beispiele: Diese Route legt Daten an oder ändert sie, deshalb sendet die Referenz sie nie. Anfragebeispiele stehen in der Anleitung oben.
GET /api/qr/{token}/session
Braucht keinen API-Schlüssel: Das Credential ist Teil der URL (ein QR-Token, Ticketcode, Storno-Token oder Gutscheincode, den der Gast erhalten hat).
Anleitung und Beispiele: QR-Codes und Tischsitzungen
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
token | path | string | Ja | – | – |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt; die type-URL führt zur Erklärung. Alle Problemtypen.
GET /api/registrations/{cancelToken}
Braucht keinen API-Schlüssel: Das Credential ist Teil der URL (ein QR-Token, Ticketcode, Storno-Token oder Gutscheincode, den der Gast erhalten hat).
Anleitung und Beispiele: Events
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
cancelToken | path | string | Ja | – | – |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt; die type-URL führt zur Erklärung. Alle Problemtypen.
GET /api/reservations/{cancelToken}
Braucht keinen API-Schlüssel: Das Credential ist Teil der URL (ein QR-Token, Ticketcode, Storno-Token oder Gutscheincode, den der Gast erhalten hat).
Anleitung und Beispiele: Reservierungen
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
cancelToken | path | string | Ja | – | – |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt; die type-URL führt zur Erklärung. Alle Problemtypen.
POST /api/reservations/{cancelToken}/cancel
Braucht keinen API-Schlüssel: Das Credential ist Teil der URL (ein QR-Token, Ticketcode, Storno-Token oder Gutscheincode, den der Gast erhalten hat).
Anleitung und Beispiele: Reservierungen
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
cancelToken | path | string | Ja | – | – |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt; die type-URL führt zur Erklärung. Alle Problemtypen.
Nur Beispiele: Diese Route legt Daten an oder ändert sie, deshalb sendet die Referenz sie nie. Anfragebeispiele stehen in der Anleitung oben.
POST /api/reservations/{cancelToken}/push
Braucht keinen API-Schlüssel: Das Credential ist Teil der URL (ein QR-Token, Ticketcode, Storno-Token oder Gutscheincode, den der Gast erhalten hat).
Anleitung und Beispiele: Reservierungen
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
cancelToken | path | string | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
deviceId | string | Nein | Ja | – | 22 base64url characters as the server minted it, or null. |
Antworten
- 200 OK ·
application/json→GuestPushRegistrationResponseGuestPushRegistrationResponse Feld Typ Pflicht Null erlaubt Einschränkungen Beschreibung enabledbooleanJa – – False when push is not configured on the server: the client shows no opt-in and the other members are null. appIdstringJa Ja – The public OneSignal App ID the SDK initialises with. externalIdstringJa Ja – What the device logs in to the push provider as: pseudonymous, never the booking's token or reference. Keep it on the device and never show or log it. deviceIdstringJa Ja – The device id to keep on the device and send with the next booking.
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt; die type-URL führt zur Erklärung. Alle Problemtypen.
Nur Beispiele: Diese Route legt Daten an oder ändert sie, deshalb sendet die Referenz sie nie. Anfragebeispiele stehen in der Anleitung oben.
POST /api/reservations/{cancelToken}/push/unsubscribe
Braucht keinen API-Schlüssel: Das Credential ist Teil der URL (ein QR-Token, Ticketcode, Storno-Token oder Gutscheincode, den der Gast erhalten hat).
Anleitung und Beispiele: Reservierungen
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
cancelToken | path | string | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
deviceId | string | Ja | – | – |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt; die type-URL führt zur Erklärung. Alle Problemtypen.
Nur Beispiele: Diese Route legt Daten an oder ändert sie, deshalb sendet die Referenz sie nie. Anfragebeispiele stehen in der Anleitung oben.
GET /api/tickets/{code}
Braucht keinen API-Schlüssel: Das Credential ist Teil der URL (ein QR-Token, Ticketcode, Storno-Token oder Gutscheincode, den der Gast erhalten hat).
Anleitung und Beispiele: Events
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
code | path | string | Ja | – | – |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt; die type-URL führt zur Erklärung. Alle Problemtypen.
POST /api/venues/{venueSlug}/messages
Braucht einen API-Schlüssel in X-BookDinePlay-Key oder Authorization: Bearer. Ein veröffentlichbarer Schlüssel muss von einem erlaubten Origin kommen; ein geheimer Schlüssel darf keinen Origin senden.
Anleitung und Beispiele: Nachrichten
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
venueSlug | path | string | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
guestName | string | Ja | – | – | |
guestEmail | string | Ja | – | – | |
subject | string | Ja | – | – | |
body | string | Ja | – | – |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:
missing-api-keyinvalid-api-keyvenue-mismatchorigin-not-allowedsecret-key-from-browserpublishable-key-without-originapp-key-from-browser
Nur Beispiele: Diese Route legt Daten an oder ändert sie, deshalb sendet die Referenz sie nie. Anfragebeispiele stehen in der Anleitung oben.
GET /api/vouchers/{code}
Braucht keinen API-Schlüssel: Das Credential ist Teil der URL (ein QR-Token, Ticketcode, Storno-Token oder Gutscheincode, den der Gast erhalten hat).
Anleitung und Beispiele: Gutscheine
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
code | path | string | Ja | – | – |
Antworten
- 200 OK ·
application/json→GuestVoucherResponseGuestVoucherResponse Feld Typ Pflicht Null erlaubt Einschränkungen Beschreibung venueSlugstringJa – – venueNamestringJa – – displayCodestringJa – – The code in its display form ( K7QM-2XRP-9DTA-HV3N-8W4F) — the caller already holds it; it is echoed so the page never has to re-derive it.kindVoucherKindJa – einer von: Amount,Percentage,ItemWhat a voucher is worth, and so how it redeems. statusVoucherDisplayStatusJa – einer von: Active,PartlyUsed,UsedUp,Expired,VoidedWhat the guest sees: active, partly used, used up, expired or voided. currencystringJa – – The voucher's currency (ISO 4217). balancenumber (double)Ja Ja Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$What an VoucherKind.Amount voucher can still pay, live online checkouts subtracted. Null for percentage and item vouchers, which are used once. faceValuenumber (double)Ja Ja Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$The value an VoucherKind.Amount voucher was issued with. percentagenumber (double)Ja Ja Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$A VoucherKind.Percentage voucher's discount, 0.01–100. maxDiscountnumber (double)Ja Ja Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$The venue's optional cap on a percentage discount, in money. itemNamestringJa Ja – An VoucherKind.Item voucher's menu item, as named at issue. expiresOnstringJa – – The last valid day, venue-local, yyyy-MM-dd.termsstringJa Ja – The venue's voucher terms as snapshotted at issue, in the voucher's language. recipientNamestringJa Ja – giftMessagestringJa Ja – guestUrlstringJa – – This page's own address in the guest Web App, {AppBaseUrl}/v/{DisplayCode}.qrSvgstringJa – – A self-contained SVG QR code of GuestUrl. - 404 Not Found ·
application/problem+json→ProblemDetails - 429 Too Many Requests ·
application/problem+json→ProblemDetails
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt; die type-URL führt zur Erklärung. Alle Problemtypen.
GET /api/venues/{venueSlug}/highlights
Braucht einen API-Schlüssel in X-BookDinePlay-Key oder Authorization: Bearer. Ein veröffentlichbarer Schlüssel muss von einem erlaubten Origin kommen; ein geheimer Schlüssel darf keinen Origin senden.
Anleitung und Beispiele: Highlights
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
venueSlug | path | string | Ja | – | – |
Antworten
- 200 OK
Problemtypen
Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:
Authentifizierte Endpunkte
Die Routen der Betreiberkonsole und der Plattform. Sie erwarten ein Auth0-Bearer-Token, keinen API-Schlüssel, und sind nicht für Integrationen Dritter gedacht – deshalb gibt es dafür kein „Ausprobieren“. Sie sind aufgeführt, damit die gesamte Oberfläche an einer Stelle dokumentiert ist.
POST /api/admin/demo-venues/{venueSlug}/reset
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
venueSlug | path | string | Ja | – | – |
Antworten
- 200 OK
POST /api/admin/impersonate/{tenantId}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
tenantId | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
GET /api/admin/me
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
GET /api/admin/reservations
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
venueSlug | query | string | Ja | – | – |
date | query | string | Ja | – | – |
Antworten
- 200 OK
POST /api/admin/reservations/{venueSlug}/{reference}/status
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
venueSlug | path | string | Ja | – | – |
reference | path | string | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
status | ReservationStatus | Ja | – | einer von: Pending, Confirmed, Cancelled, Completed, NoShow, PaidButUnavailable | Lifecycle status of a reservation. |
Antworten
- 200 OK
POST /api/admin/stripe/test-data-cleanup
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
dryRun | query | boolean | Nein | – | – |
Antworten
- 200 OK
GET /api/admin/tenants
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
POST /api/admin/tenants
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
name | string | Ja | – | – | |
slug | string | Ja | – | – | |
plan | PlanTier | Ja | – | einer von: Starter, Pro, Premium | Subscription plans a tenant can be on. Higher tiers are supersets of lower ones. Prices and gating are defined once in PlanCatalog (in BookDinePlay.Domain) so the marketing site, onboarding, and in-app entitlement checks all agree. |
Antworten
- 200 OK
GET /api/admin/tenants/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
PUT /api/admin/tenants/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
name | string | Ja | – | – | |
plan | PlanTier | Ja | – | einer von: Starter, Pro, Premium | Subscription plans a tenant can be on. Higher tiers are supersets of lower ones. Prices and gating are defined once in PlanCatalog (in BookDinePlay.Domain) so the marketing site, onboarding, and in-app entitlement checks all agree. |
status | TenantStatus | Ja | – | einer von: Active, Suspended, PendingBilling | Lifecycle status of a tenant account. |
billing | BillingMode | Nein | Ja | einer von: Manual, Stripe, AppStore, GooglePlay |
Antworten
- 200 OK
POST /api/admin/tenants/{id}/billing/resync
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
GET /api/admin/tenants/{id}/operators
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
POST /api/admin/tenants/{id}/operators
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
email | string | Ja | – | – | |
displayName | string | Ja | – | – | |
auth0Subject | string | Ja | – | – | Deliberately required, not optional: OperatorContextResolver authorizes an operator by Auth0 subject alone, so a row created without one is a row that can never sign in — a silent dead end for whoever was told their account was ready. The platform admin reads this value from the Auth0 dashboard or Management API. There is no invite-by-email flow here on purpose: an unverified e-mail is not proof that the invitee owns it, and folding that decision into this endpoint would make it implicitly rather than deliberately. Bounded to int FieldLengths.Auth0Subject (128 characters), the same width Operators.Auth0Subject (and its two duplicates, Employees.Auth0Subject and LegalAcceptances.Auth0Subject) are configured with in BookDinePlayDbContext. |
venueSlug | string | Nein | Ja | – | Restricts the operator to this one venue of the tenant (epic #458); null (the default and what every earlier client sends) makes a tenant-wide operator. A slug that is not one of the tenant's venues is refused with a validation problem. Null means the same thing on every path that reads it, so there is nothing to preserve: change it later with AssignOperatorVenueRequest. |
Antworten
- 200 OK
POST /api/admin/tenants/{id}/operators/invite
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
email | string | Ja | – | – | The invitee's e-mail address; the invite is sent here and it must not belong to a user of another Auth0 connection (Google, Apple, Microsoft) nor to an operator of another tenant. |
displayName | string | Ja | – | – | Shown in the console and the mail. |
venueSlug | string | Nein | Ja | – | Optional: restricts the operator to one venue of the tenant; omitted means every venue. Only applied when the operator row is created now; an existing operator keeps its current scope. |
language | string | Nein | Ja | – | Optional mail language, en or de; omitted uses the tenant's UI language. |
Antworten
- 200 OK
PUT /api/admin/tenants/{id}/operators/{operatorId}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
operatorId | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
displayName | string | Ja | – | – | |
auth0Subject | string | Ja | – | – |
Antworten
- 200 OK
PUT /api/admin/tenants/{id}/operators/{operatorId}/venue-access
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
operatorId | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
venueSlug | string | Ja | Ja | – | The one venue of the tenant to restrict the operator to, or null for tenant-wide. |
Antworten
- 200 OK
GET /api/admin/tenants/{id}/venues
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
POST /api/onboarding
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
tenantName | string | Ja | – | – | |
slug | string | Ja | – | – | |
plan | PlanTier | Ja | – | einer von: Starter, Pro, Premium | Subscription plans a tenant can be on. Higher tiers are supersets of lower ones. Prices and gating are defined once in PlanCatalog (in BookDinePlay.Domain) so the marketing site, onboarding, and in-app entitlement checks all agree. |
email | string | Ja | – | – | |
displayName | string | Ja | – | – | |
company | CompanyProfileDto | Nein | Ja | – | The billing/company profile a tenant is invoiced under: legal entity, invoice address, optional VAT id, and who to contact about billing. Mirrors BookDinePlay.Domain.Billing.CompanyProfile field for field; validation lives there and the API reports it as an RFC 7807 errors dictionary keyed by these property names in camelCase (legalName, addressLine1, postalCode, city, country, vatId, billingEmail, contactName). |
company.legalName | string | Ja | – | – | |
company.addressLine1 | string | Ja | – | – | |
company.addressLine2 | string | Ja | Ja | – | |
company.postalCode | string | Ja | – | – | |
company.city | string | Ja | – | – | |
company.country | string | Ja | – | – | ISO 3166-1 alpha-2 country code, e.g. "DE". |
company.vatId | string | Ja | Ja | – | Optional VAT identification number, e.g. "DE123456789"; format-checked only, never against a tax authority. |
company.billingEmail | string | Ja | – | – | |
company.contactName | string | Ja | – | – | |
interval | BillingInterval | Nein | – | einer von: Monthly, Yearly | Monthly or yearly billing for the chosen plan. |
acceptances | array of AcceptLegalDocumentDto | Nein | Ja | – | The legal documents the operator ticked, each at the version they were shown. Every document in force must be covered or the sign-up is refused. |
acceptances[].kind | LegalDocumentKind | Ja | – | einer von: Terms, DataProcessingAgreement | A legal document BookDinePlay publishes in numbered versions and every operator accepts at sign-up (and again when a newer version takes effect). |
acceptances[].version | string | Ja | – | – | |
acceptances[].language | string | Ja | – | – | |
uiLanguage | string | Nein | Ja | – | The operator's UI language ("en"/"de", or a culture like "de-AT"), kept on the tenant so billing e-mails are written in it. Falls back to the request's culture. |
billing | OnboardingBillingSource | Nein | Ja | einer von: Web, AppStore, GooglePlay |
Antworten
- 200 OK
GET /api/onboarding/legal-documents
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
language | query | string | Nein | – | – |
Antworten
- 200 OK
GET /api/onboarding/slug-available
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
slug | query | string | Nein | – | – |
Antworten
- 200 OK
GET /api/onboarding/status
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
DELETE /api/operator/account
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
GET /api/operator/billing
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
POST /api/operator/billing/app-store/transactions
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
signedTransaction | string | Ja | – | – | The JWS; empty when TransactionId is given instead. |
transactionId | string | Nein | Ja | – | A StoreKit 1 transactionIdentifier: the server fetches that transaction's signed JWS from the App Store Server API ("Get Transaction Info") and verifies it exactly like a posted one. The .NET store apps use this, because .NET for iOS does not bind StoreKit 2 (OutaStory's #1163 approach). Appended (#185): payloads without it bind as before. |
Antworten
- 200 OK
POST /api/operator/billing/checkout-return
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
sessionId | string | Ja | – | – |
Antworten
- 200 OK
POST /api/operator/billing/checkout-session
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
tier | PlanTier | Ja | – | einer von: Starter, Pro, Premium | Subscription plans a tenant can be on. Higher tiers are supersets of lower ones. Prices and gating are defined once in PlanCatalog (in BookDinePlay.Domain) so the marketing site, onboarding, and in-app entitlement checks all agree. |
interval | BillingInterval | Ja | – | einer von: Monthly, Yearly | Billing cadence for a subscription. |
Antworten
- 200 OK
PUT /api/operator/billing/company
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
legalName | string | Ja | – | – | |
addressLine1 | string | Ja | – | – | |
addressLine2 | string | Ja | Ja | – | |
postalCode | string | Ja | – | – | |
city | string | Ja | – | – | |
country | string | Ja | – | – | ISO 3166-1 alpha-2 country code, e.g. "DE". |
vatId | string | Ja | Ja | – | Optional VAT identification number, e.g. "DE123456789"; format-checked only, never against a tax authority. |
billingEmail | string | Ja | – | – | |
contactName | string | Ja | – | – |
Antworten
- 200 OK
POST /api/operator/billing/google-play/purchases
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
purchaseToken | string | Ja | – | max. 512 Zeichen | |
productId | string | Nein | Ja | max. 100 Zeichen |
Antworten
- 200 OK
POST /api/operator/billing/portal-session
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
intent | string | Ja | – | – | What the operator wants to do: manage, changePlan or cancel (matched case-insensitively). A string rather than an enum so the console's three buttons stay readable in the wire format. |
tier | PlanTier | Nein | Ja | einer von: Starter, Pro, Premium | Subscription plans a tenant can be on. Higher tiers are supersets of lower ones. Prices and gating are defined once in PlanCatalog (in BookDinePlay.Domain) so the marketing site, onboarding, and in-app entitlement checks all agree. |
interval | BillingInterval | Nein | Ja | einer von: Monthly, Yearly | Billing cadence for a subscription. |
Antworten
- 200 OK
GET /api/operator/billing/store
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
GET /api/operator/employees
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
POST /api/operator/employees
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
email | string | Ja | – | – | |
displayName | string | Ja | – | – | |
role | EmployeeRole | Ja | – | einer von: Manager, Staff | An employee's role within a venue. |
Antworten
- 200 OK
POST /api/operator/employees/{id}/assignments
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
resourceId | string | Ja | – | – | |
resourceName | string | Ja | – | – | |
resourceType | BookableResourceType | Ja | – | einer von: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar | The kinds of bookable resource a venue can publish. A restaurant table booking uses the same reservation model as a billiard or dart booking; only the type and pricing rules differ. |
Antworten
- 200 OK
DELETE /api/operator/employees/{id}/assignments/{resourceId}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
resourceId | path | string | Ja | – | – |
Antworten
- 200 OK
POST /api/operator/employees/{id}/status
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
isActive | boolean | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/guest-blocks
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
POST /api/operator/guest-blocks
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
email | string | Ja | Ja | – | |
phone | string | Ja | Ja | – | |
reason | string | Ja | – | – | Why (required, at most 500 characters). Kept in the log for the window. |
Antworten
- 200 OK
GET /api/operator/guest-blocks/settings
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
PUT /api/operator/guest-blocks/settings
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
enabled | boolean | Ja | – | – | |
threshold | integer (int32) | Ja | – | – | |
windowMonths | integer (int32) | Ja | – | – |
Antworten
- 200 OK
POST /api/operator/guest-blocks/unblock
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
guestRef | string | Ja | Ja | – | |
email | string | Ja | Ja | – | |
phone | string | Ja | Ja | – | |
reason | string | Ja | – | – | Why (required, at most 500 characters). Kept in the log for the window. |
Antworten
- 200 OK
POST /api/operator/legal/acceptances
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
documents | array of AcceptLegalDocumentDto | Ja | – | – | |
documents[].kind | LegalDocumentKind | Ja | – | einer von: Terms, DataProcessingAgreement | A legal document BookDinePlay publishes in numbered versions and every operator accepts at sign-up (and again when a newer version takes effect). |
documents[].version | string | Ja | – | – | |
documents[].language | string | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/legal/status
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
GET /api/operator/me
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
GET /api/operator/push/registration
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK ·
application/json→PushRegistrationResponsePushRegistrationResponse Feld Typ Pflicht Null erlaubt Einschränkungen Beschreibung enabledbooleanJa – – False when push is not configured on the server (no OneSignal app yet): the clients show no opt-in. The other two members are then null. appIdstringJa Ja – The public OneSignal App ID the SDK initialises with. externalIdstringJa Ja – The person's push id: pseudonymous, minted by the server, never the sign-in subject. Treat it like a session value - keep it on the device it was issued to and never show or log it.
GET /api/operator/team
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
POST /api/operator/team/invitations
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
email | string | Ja | – | – | |
displayName | string | Ja | – | – | |
role | TeamRole | Nein | – | einer von: Staff, Manager, Owner | Manager or Staff (an Owner is never invited through the team). |
employeeId | string (uuid) | Nein | Ja | – | An employee record of this venue (or a shared one) to link the login to. Without it, an unlinked employee with the same e-mail is linked when there is exactly one. |
language | string | Nein | Ja | – | The invite mail's language, en or de; the account's language when omitted. |
Antworten
- 200 OK
DELETE /api/operator/team/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
PUT /api/operator/team/{id}/employee
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
employeeId | string (uuid) | Ja | Ja | – |
Antworten
- 200 OK
PUT /api/operator/team/{id}/role
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
role | TeamRole | Ja | – | einer von: Staff, Manager, Owner | What a tenant's back-office user may do inside the tenant (issue #562). Ordered from least to most: a higher role can do everything a lower one can. * TeamRole.Staff: bookings, orders, the day view and guest messages at one venue, only during their shifts (#563). * TeamRole.Manager: everything a venue-bound operator can at one venue, plus its staff and shifts. * TeamRole.Owner: a tenant-wide operator; every venue, billing and the team. Never restricted by shifts. Persisted by name (nvarchar(16)); appended members only. |
Antworten
- 200 OK
GET /api/operator/venue
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
POST /api/operator/venue
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
slug | string | Ja | – | – | |
name | string | Ja | – | – | |
tagline | string | Ja | – | – | |
description | string | Ja | – | – | |
city | string | Ja | – | – | |
country | string | Ja | – | – | |
timezone | string | Ja | – | – | |
businessProfile | BusinessProfileDto | Ja | – | – | Venue business profile (address + contact), for the operator's edit surface. |
businessProfile.legalName | string | Ja | – | – | |
businessProfile.addressLine1 | string | Ja | – | – | |
businessProfile.addressLine2 | string | Ja | Ja | – | |
businessProfile.city | string | Ja | – | – | |
businessProfile.postalCode | string | Ja | – | – | |
businessProfile.country | string | Ja | – | – | |
businessProfile.phone | string | Ja | – | – | |
businessProfile.email | string | Ja | – | – | |
businessProfile.website | string | Ja | Ja | – | |
paymentPolicy | PaymentPolicyDto | Ja | – | – | Venue payment policy, for the operator's edit surface. |
paymentPolicy.paymentsEnabled | boolean | Ja | – | – | |
paymentPolicy.depositsEnabled | boolean | Ja | – | – | |
paymentPolicy.currency | string | Ja | – | – | |
paymentPolicy.defaultDepositAmount | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
preferredLanguage | string | Nein | – | Standard en |
Antworten
- 200 OK
PUT /api/operator/venue
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
name | string | Ja | – | – | |
tagline | string | Ja | – | – | |
description | string | Ja | – | – | |
city | string | Ja | – | – | |
country | string | Ja | – | – | |
timezone | string | Ja | – | – | |
businessProfile | BusinessProfileDto | Ja | – | – | Venue business profile (address + contact), for the operator's edit surface. |
businessProfile.legalName | string | Ja | – | – | |
businessProfile.addressLine1 | string | Ja | – | – | |
businessProfile.addressLine2 | string | Ja | Ja | – | |
businessProfile.city | string | Ja | – | – | |
businessProfile.postalCode | string | Ja | – | – | |
businessProfile.country | string | Ja | – | – | |
businessProfile.phone | string | Ja | – | – | |
businessProfile.email | string | Ja | – | – | |
businessProfile.website | string | Ja | Ja | – | |
paymentPolicy | PaymentPolicyDto | Ja | – | – | Venue payment policy, for the operator's edit surface. |
paymentPolicy.paymentsEnabled | boolean | Ja | – | – | |
paymentPolicy.depositsEnabled | boolean | Ja | – | – | |
paymentPolicy.currency | string | Ja | – | – | |
paymentPolicy.defaultDepositAmount | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
preferredLanguage | string | Nein | – | Standard en |
Antworten
- 200 OK
GET /api/operator/venue/allocation-settings
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
PUT /api/operator/venue/allocation-settings
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
forecastEnabled | boolean | Nein | Ja | – | |
lookBackWeeks | integer (int32) | Nein | Ja | – | |
quietThresholdPercent | integer (int32) | Nein | Ja | – | |
maxSpareSeats | integer (int32) | Nein | Ja | – | |
relaxedExtraSpareSeats | integer (int32) | Nein | Ja | – | |
clearMaxSpareSeats | boolean | Nein | – | Standard false |
Antworten
- 200 OK
GET /api/operator/venue/api-keys
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
POST /api/operator/venue/api-keys
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
label | string | Ja | – | – | |
type | ApiKeyType | Ja | – | einer von: Publishable, Secret, App | How a key may be used, which decides both how it is stored and where it may be sent from. |
allowedOrigins | array of string | Ja | – | – | |
delivery | ApiKeyDelivery | Nein | – | einer von: Inline, Reveal | How a newly created secret key reaches the person who asked for it (issue #501). |
Antworten
- 200 OK
POST /api/operator/venue/api-keys/reveal
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
ticket | string | Ja | – | – |
Antworten
- 200 OK
DELETE /api/operator/venue/api-keys/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/venue/app-listing
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
PUT /api/operator/venue/app-listing
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
any
Antworten
- 200 OK
GET /api/operator/venue/availability
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
date | query | string | Ja | – | – |
partySize | query | integer (int32) | Nein | – | Standard 2 |
resourceType | query | BookableResourceType | Nein | – | Standard RestaurantTableeiner von: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar |
durationMinutes | query | integer (int32) | Nein | – | – |
groupBy | query | string | Nein | – | – |
resourceGroup | query | string (uuid) | Nein | – | – |
Antworten
- 200 OK
GET /api/operator/venue/booking-durations
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
PUT /api/operator/venue/booking-durations
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
rules | array of BookingDurationRuleDto | Ja | – | – | |
rules[].type | BookableResourceType | Ja | – | einer von: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar | The kinds of bookable resource a venue can publish. A restaurant table booking uses the same reservation model as a billiard or dart booking; only the type and pricing rules differ. |
rules[].defaultMinutes | integer (int32) | Ja | – | – | |
rules[].minMinutes | integer (int32) | Ja | – | – | |
rules[].maxMinutes | integer (int32) | Ja | – | – | |
rules[].stepMinutes | integer (int32) | Ja | – | – | |
rules[].guestSelectable | boolean | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/venue/booking-rules
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
PUT /api/operator/venue/booking-rules
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
rules | array of UpdateBookingRuleDto | Ja | – | – | |
rules[].resourceType | BookableResourceType | Ja | – | einer von: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar | The kinds of bookable resource a venue can publish. A restaurant table booking uses the same reservation model as a billiard or dart booking; only the type and pricing rules differ. |
rules[].minimumNoticeMinutes | integer (int32) | Nein | Ja | – | |
rules[].bufferMinutes | integer (int32) | Nein | Ja | – | |
rules[].minPartySize | integer (int32) | Nein | Ja | – | |
rules[].maxPartySize | integer (int32) | Nein | Ja | – |
Antworten
- 200 OK
GET /api/operator/venue/cancellation-policy
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
PUT /api/operator/venue/cancellation-policy
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
enabled | boolean | Ja | – | – | |
hoursBeforeStart | integer (int32) | Ja | – | – | |
depositRefund | ReservationDepositRefundMode | Nein | – | einer von: NoOnlineRefund, RefundOnGuestCancel, ForfeitOnGuestCancel | What happens to a deposit the guest already paid online when they cancel (issue #103). Trailing and defaulted to ReservationDepositRefundMode.NoOnlineRefund, which is today's behaviour, so a pre-0.12 payload still binds. Non-nullable on purpose, mirroring OperatorEventRegistrationSettingsDto.RefundPolicyMode: this is a whole-policy PUT that always carries every field, so there is no "the caller did not supply this" case for a null to express — see AGENTS.md's nullable-mutation-DTO rule for why the nullable shape would be the worse choice here, not the safer one. |
Antworten
- 200 OK
GET /api/operator/venue/child-rules
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
PUT /api/operator/venue/child-rules
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
rules | array of ChildRuleDto | Ja | – | – | |
rules[].resourceType | BookableResourceType | Ja | – | einer von: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar | The kinds of bookable resource a venue can publish. A restaurant table booking uses the same reservation model as a billiard or dart booking; only the type and pricing rules differ. |
rules[].maxChildrenPerSlot | integer (int32) | Nein | Ja | – | Most children that may be booked on the type in the same window (all resources of the type together; 0 = no children at all). Null = no limit. |
rules[].noChildrenFrom | string | Nein | Ja | – | Start of the daily window with no children, venue-local HH:mm; set together with NoChildrenUntil. A booking running into the window is refused when it names children. |
rules[].noChildrenUntil | string | Nein | Ja | – | End of that window, HH:mm. An end at or before the start runs past midnight; use 00:00 for "until midnight". |
Antworten
- 200 OK
GET /api/operator/venue/children-settings
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
PUT /api/operator/venue/children-settings
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
any
Antworten
- 200 OK
GET /api/operator/venue/events
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
POST /api/operator/venue/events
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
title | string | Ja | Ja | – | |
slug | string | Ja | Ja | – | |
excerpt | string | Ja | Ja | – | |
descriptionMarkdown | string | Ja | Ja | – | |
imageUrl | string | Ja | Ja | – | |
imageAlt | string | Ja | Ja | – | |
date | string (date) | Ja | Ja | – | |
start | string (time) | Ja | Ja | – | |
end | string (time) | Ja | Ja | – | |
timeLabel | string | Ja | Ja | – | |
locationLabel | string | Ja | Ja | – | |
registration | OperatorEventRegistrationSettingsDto | Ja | Ja | – | How guests may register, as edited in the console and echoed back on every event read. On write, int? OperatorEventRegistrationSettingsDto.MaxTicketsPerRegistration null means the default (6); decimal? OperatorEventRegistrationSettingsDto.TicketPrice and string? OperatorEventRegistrationSettingsDto.Currency are only meaningful for EventRegistrationMode.Paid and are dropped on save for any other mode. DateTimeOffset? OperatorEventRegistrationSettingsDto.ClosesAt is a UTC instant. RefundPolicyMode OperatorEventRegistrationSettingsDto.RefundPolicyMode and int OperatorEventRegistrationSettingsDto.RefundHoursBeforeStart are only meaningful for EventRegistrationMode.Paid too; int OperatorEventRegistrationSettingsDto.RefundHoursBeforeStart must be 0–720 and is only read when the mode is RefundPolicyMode.FullRefundUntil. decimal? OperatorEventRegistrationSettingsDto.ChildTicketPrice (#556) is what a child's ticket costs in string? OperatorEventRegistrationSettingsDto.Currency: 0 means children are free, null that a child pays decimal? OperatorEventRegistrationSettingsDto.TicketPrice; like the price it is dropped on save for any mode but Paid. |
registration.mode | EventRegistrationMode | Ja | – | einer von: None, Free, Paid | Whether guests can register for an event, and whether a ticket costs money. |
registration.capacity | integer (int32) | Ja | Ja | – | |
registration.maxTicketsPerRegistration | integer (int32) | Ja | Ja | – | |
registration.closesAt | string (date-time) | Ja | Ja | – | |
registration.ticketPrice | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
registration.currency | string | Ja | Ja | – | |
registration.refundPolicyMode | RefundPolicyMode | Nein | – | einer von: NoOnlineRefund, FullRefundUntil | How a Paid event's tickets may be refunded online by the guest. See BookDinePlay.Domain.Events.EventRefundPolicy. Only meaningful for EventRegistrationMode.Paid events. |
registration.refundHoursBeforeStart | integer (int32) | Nein | – | Standard 0 | |
registration.childTicketPrice | number (double) | Nein | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
language | string | Ja | Ja | – |
Antworten
- 200 OK
POST /api/operator/venue/events/preview
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
markdown | string | Ja | Ja | – |
Antworten
- 200 OK
GET /api/operator/venue/events/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
PUT /api/operator/venue/events/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
title | string | Ja | Ja | – | |
slug | string | Ja | Ja | – | |
excerpt | string | Ja | Ja | – | |
descriptionMarkdown | string | Ja | Ja | – | |
imageUrl | string | Ja | Ja | – | |
imageAlt | string | Ja | Ja | – | |
date | string (date) | Ja | Ja | – | |
start | string (time) | Ja | Ja | – | |
end | string (time) | Ja | Ja | – | |
timeLabel | string | Ja | Ja | – | |
locationLabel | string | Ja | Ja | – | |
registration | OperatorEventRegistrationSettingsDto | Ja | Ja | – | How guests may register, as edited in the console and echoed back on every event read. On write, int? OperatorEventRegistrationSettingsDto.MaxTicketsPerRegistration null means the default (6); decimal? OperatorEventRegistrationSettingsDto.TicketPrice and string? OperatorEventRegistrationSettingsDto.Currency are only meaningful for EventRegistrationMode.Paid and are dropped on save for any other mode. DateTimeOffset? OperatorEventRegistrationSettingsDto.ClosesAt is a UTC instant. RefundPolicyMode OperatorEventRegistrationSettingsDto.RefundPolicyMode and int OperatorEventRegistrationSettingsDto.RefundHoursBeforeStart are only meaningful for EventRegistrationMode.Paid too; int OperatorEventRegistrationSettingsDto.RefundHoursBeforeStart must be 0–720 and is only read when the mode is RefundPolicyMode.FullRefundUntil. decimal? OperatorEventRegistrationSettingsDto.ChildTicketPrice (#556) is what a child's ticket costs in string? OperatorEventRegistrationSettingsDto.Currency: 0 means children are free, null that a child pays decimal? OperatorEventRegistrationSettingsDto.TicketPrice; like the price it is dropped on save for any mode but Paid. |
registration.mode | EventRegistrationMode | Ja | – | einer von: None, Free, Paid | Whether guests can register for an event, and whether a ticket costs money. |
registration.capacity | integer (int32) | Ja | Ja | – | |
registration.maxTicketsPerRegistration | integer (int32) | Ja | Ja | – | |
registration.closesAt | string (date-time) | Ja | Ja | – | |
registration.ticketPrice | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
registration.currency | string | Ja | Ja | – | |
registration.refundPolicyMode | RefundPolicyMode | Nein | – | einer von: NoOnlineRefund, FullRefundUntil | How a Paid event's tickets may be refunded online by the guest. See BookDinePlay.Domain.Events.EventRefundPolicy. Only meaningful for EventRegistrationMode.Paid events. |
registration.refundHoursBeforeStart | integer (int32) | Nein | – | Standard 0 | |
registration.childTicketPrice | number (double) | Nein | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
language | string | Ja | Ja | – |
Antworten
- 200 OK
DELETE /api/operator/venue/events/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
POST /api/operator/venue/events/{id}/cancel
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
POST /api/operator/venue/events/{id}/check-in
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
code | string | Ja | Ja | – |
Antworten
- 200 OK
POST /api/operator/venue/events/{id}/publish
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/venue/events/{id}/registrations
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
page | query | integer (int32) | Nein | – | – |
pageSize | query | integer (int32) | Nein | – | – |
status | query | string | Nein | – | – |
Antworten
- 200 OK
GET /api/operator/venue/events/{id}/registrations.csv
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/venue/events/{id}/registrations/{registrationId}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
registrationId | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
POST /api/operator/venue/events/{id}/registrations/{registrationId}/cancel
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
registrationId | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
POST /api/operator/venue/events/{id}/registrations/{registrationId}/refund
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
registrationId | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
POST /api/operator/venue/events/{id}/tickets/{code}/undo-check-in
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
code | path | string | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/venue/extras
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
PUT /api/operator/venue/extras
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
extras | array of SaveExtraDto | Ja | – | – | |
extras[].id | string | Ja | Ja | – | |
extras[].name | string | Ja | – | – | |
extras[].description | string | Ja | – | – | |
extras[].price | number (double) | Ja | – | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
extras[].basis | ExtraPricingBasis | Ja | – | einer von: PerPerson, PerBooking | How an extra is charged. |
extras[].appliesTo | array of BookableResourceType | Ja | – | einer von: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar |
Antworten
- 200 OK
GET /api/operator/venue/floor-plan
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
PUT /api/operator/venue/floor-plan
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
placements | array of PlacementDto | Ja | – | – | |
placements[].code | string | Ja | – | – | |
placements[].zoneId | string (uuid) | Ja | Ja | – | |
placements[].x | number (double) | Ja | – | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$ | |
placements[].y | number (double) | Ja | – | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$ | |
placements[].width | number (double) | Ja | – | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$ | |
placements[].height | number (double) | Ja | – | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$ | |
placements[].shape | string | Ja | – | – | |
placements[].rotation | integer (int32) | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/venue/high-chairs
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
PUT /api/operator/venue/high-chairs
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
any
Antworten
- 200 OK
GET /api/operator/venue/highlights
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
POST /api/operator/venue/highlights
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
status | HighlightStatus | Ja | – | einer von: Draft, Published | Draft or published. |
title | string | Ja | – | – | The headline. |
text | string | Ja | Ja | – | Optional short text. |
imageUrl | string | Ja | Ja | – | The card's image (required); an upload through POST /api/operator/venue/menus/media returns one. |
linkKind | HighlightLinkKind | Ja | – | einer von: None, MenuItem, Event, VoucherProduct, External | What the card links to. |
linkTarget | string | Ja | Ja | – | Required for every kind but None; refused with None. |
sortOrder | integer (int32) | Ja | – | – | Manual order among highlights (0 to 999). |
visibleFrom | string (date) | Ja | Ja | – | First venue-local day the card shows; null means no lower bound. |
visibleTo | string (date) | Ja | Ja | – | Last venue-local day the card shows; null means no upper bound. |
Antworten
- 200 OK
GET /api/operator/venue/highlights/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
PUT /api/operator/venue/highlights/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
status | HighlightStatus | Ja | – | einer von: Draft, Published | Draft or published. |
title | string | Ja | – | – | The headline. |
text | string | Ja | Ja | – | Optional short text. |
imageUrl | string | Ja | Ja | – | The card's image (required); an upload through POST /api/operator/venue/menus/media returns one. |
linkKind | HighlightLinkKind | Ja | – | einer von: None, MenuItem, Event, VoucherProduct, External | What the card links to. |
linkTarget | string | Ja | Ja | – | Required for every kind but None; refused with None. |
sortOrder | integer (int32) | Ja | – | – | Manual order among highlights (0 to 999). |
visibleFrom | string (date) | Ja | Ja | – | First venue-local day the card shows; null means no lower bound. |
visibleTo | string (date) | Ja | Ja | – | Last venue-local day the card shows; null means no upper bound. |
Antworten
- 200 OK
DELETE /api/operator/venue/highlights/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
POST /api/operator/venue/media
Braucht ein Auth0-Bearer-Token.
Anfrage-Body multipart/form-data
string (binary)
Antworten
- 200 OK
DELETE /api/operator/venue/media/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/venue/messages
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
POST /api/operator/venue/messages/{threadId}/reply
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
threadId | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
body | string | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/venue/notification-preferences
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
PUT /api/operator/venue/notification-preferences
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
newBookings | boolean | Ja | – | – | |
bookingRequests | boolean | Ja | – | – | |
cancellations | boolean | Ja | – | – | |
guestMessages | boolean | Ja | – | – | |
allOrders | boolean | Ja | – | – | |
orderStationIds | array of string (uuid) | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/venue/opening-hours
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
PUT /api/operator/venue/opening-hours
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
regular | array of OperatorDayHoursDto | Ja | – | – | |
regular[].day | string | Ja | – | – | |
regular[].isClosed | boolean | Ja | – | – | |
regular[].opens | string | Ja | Ja | – | |
regular[].closes | string | Ja | Ja | – | |
regular[].breaks | array of HoursBreakDto | Ja | – | – | |
regular[].breaks[].start | string | Ja | – | – | |
regular[].breaks[].end | string | Ja | – | – | |
special | array of OperatorSpecialHoursDto | Ja | – | – | |
special[].date | string | Ja | – | – | |
special[].isClosed | boolean | Ja | – | – | |
special[].opens | string | Ja | Ja | – | |
special[].closes | string | Ja | Ja | – | |
special[].note | string | Ja | Ja | – | |
special[].breaks | array of HoursBreakDto | Ja | – | – | |
special[].breaks[].start | string | Ja | – | – | |
special[].breaks[].end | string | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/venue/orders
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
GET /api/operator/venue/payouts
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
POST /api/operator/venue/payouts/onboarding-link
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
POST /api/operator/venue/payouts/refresh
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
GET /api/operator/venue/qr-codes
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
POST /api/operator/venue/qr-codes/generate
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
DELETE /api/operator/venue/qr-codes/{code}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
code | path | string | Ja | – | – |
Antworten
- 200 OK
POST /api/operator/venue/qr-codes/{code}/regenerate
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
code | path | string | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/venue/request-settings
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
PUT /api/operator/venue/request-settings
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
groupRequestThreshold | integer (int32) | Nein | Ja | – | From this many persons a guest booking is a request (2 to 200); null switches the group rule off. Null means the same thing on every path that reads it, so there is nothing to preserve. |
holdMinutes | integer (int32) | Nein | – | Standard 1440 | How long an unanswered request keeps its tables before it expires, in whole quarter hours from 30 minutes to 7 days. Default 1440 (24 hours). |
childrenSlots | array of HighValueSlotDto | Nein | Ja | – | The windows in which a booking with children is a request; empty switches the rule off. At most 20. |
childrenSlots[].name | string | Ja | Ja | – | A label for the console ("Friday and Saturday evening"); at most 80 characters. |
childrenSlots[].days | array of DayOfWeek | Ja | – | einer von: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday | The weekdays it applies to; at least one, no repeats. |
childrenSlots[].from | string | Ja | – | – | First start time that is inside the window, HH:mm venue-local. |
childrenSlots[].to | string | Ja | – | – | First start time that is outside it again, HH:mm. A To that is not after From runs past midnight (22:00 to 02:00). |
childrenSlots[].validFrom | string | Nein | Ja | – | First date the window is in force, yyyy-MM-dd, inclusive; null = from the start. |
childrenSlots[].validTo | string | Nein | Ja | – | Last date it is in force, inclusive; null = without end. |
Antworten
- 200 OK
GET /api/operator/venue/requests
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
POST /api/operator/venue/requests/{reference}/approve
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
reference | path | string | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
depositAmount | number (double) | Nein | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | Attaches a deposit the guest pays online to secure the booking (in the venue's payment currency); null (or omitted) confirms the booking right away. A positive amount keeps it pending until it is paid, through the same deposit flow as any booking. |
Antworten
- 200 OK
POST /api/operator/venue/requests/{reference}/decline
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
reference | path | string | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
message | string | Nein | Ja | – | An optional note to the guest, at most 500 characters, quoted in the decline e-mail. |
Antworten
- 200 OK
GET /api/operator/venue/reservations
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
date | query | string | Ja | – | – |
Antworten
- 200 OK
POST /api/operator/venue/reservations
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
resourceType | BookableResourceType | Ja | – | einer von: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar | The kinds of bookable resource a venue can publish. A restaurant table booking uses the same reservation model as a billiard or dart booking; only the type and pricing rules differ. |
resourceId | string | Nein | Ja | – | Optional specific resource id. When omitted the service picks the first available resource of the type. |
date | string | Ja | – | – | Venue-local date, "yyyy-MM-dd". |
start | string | Ja | – | – | Venue-local start time, "HH:mm". |
end | string | Nein | Ja | – | Optional venue-local end time, "HH:mm". Defaults to the resource slot length. |
partySize | integer (int32) | Ja | – | min. 1 max. 200 | |
games | integer (int32) | Nein | Ja | min. 1 max. 10 | How many games to book, for resources priced per game. Defaults to 1 when omitted. |
customerName | string | Ja | – | Länge 2–120 | |
email | string | Nein | Ja | max. 256 Zeichen | Optional here — a guest booked by phone may give no email at all. At least one of string? CreateOperatorReservationRequest.Email or string? CreateOperatorReservationRequest.Phone must be present; see IEnumerable<ValidationResult> CreateOperatorReservationRequest.Validate(ValidationContext validationContext). |
phone | string | Nein | Ja | Länge 3–40 | Optional. 3–40 characters when supplied; blank is treated as not supplied. |
notes | string | Nein | Ja | max. 500 Zeichen | |
extras | array of ExtraSelectionDto | Nein | Ja | – | Optional extras to add to the booking, e.g. shoe rental. |
extras[].extraId | string | Ja | – | – | |
extras[].quantity | integer (int32) | Ja | – | min. 1 max. 100 | |
durationMinutes | integer (int32) | Nein | Ja | min. 15 max. 1440 | Requested booking length in minutes. When omitted the venue's default for the resource type applies. Must be a duration the venue offers for that type, and the whole booking must fit inside the venue's opening hours. |
language | string | Nein | Ja | – | The guest's language ("en"/"de") for the confirmation email, as the guest stated it on the phone. Optional — when omitted, the venue's own preferred language is used instead of whatever language the operator's own console happens to be in, which says nothing about which language the guest speaks. |
children | integer (int32) | Nein | Ja | min. 0 max. 199 | How many of int CreateOperatorReservationRequest.PartySize are children (issue #554). int CreateOperatorReservationRequest.PartySize stays the total head count and the only capacity input, so adults are PartySize - Children; at least one adult must remain. Omitted or null means no children. Refused while the venue has switched the "ask for children" setting off. |
highChairs | integer (int32) | Nein | Ja | min. 0 max. 199 | High chairs reserved (issue #555): 0 up to int? CreateOperatorReservationRequest.Children, within the venue's inventory for the window. Omitted or null means none. |
Antworten
- 200 OK
GET /api/operator/venue/reservations/{reference}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
reference | path | string | Ja | – | – |
Antworten
- 200 OK
PUT /api/operator/venue/reservations/{reference}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
reference | path | string | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
resourceType | BookableResourceType | Ja | – | einer von: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar | The kinds of bookable resource a venue can publish. A restaurant table booking uses the same reservation model as a billiard or dart booking; only the type and pricing rules differ. |
resourceId | string | Nein | Ja | – | Optional. When omitted, the reservation keeps its current resource rather than being silently reassigned to whichever other resource of the type happens to be free. |
date | string | Ja | – | – | Venue-local date, "yyyy-MM-dd". |
start | string | Ja | – | – | Venue-local start time, "HH:mm". |
end | string | Nein | Ja | – | |
partySize | integer (int32) | Ja | – | min. 1 max. 200 | |
games | integer (int32) | Nein | Ja | min. 1 max. 10 | |
customerName | string | Ja | – | Länge 2–120 | |
email | string | Nein | Ja | max. 256 Zeichen | Optional; at least one of string? UpdateOperatorReservationRequest.Email or string? UpdateOperatorReservationRequest.Phone is required — see IEnumerable<ValidationResult> UpdateOperatorReservationRequest.Validate(ValidationContext validationContext). |
phone | string | Nein | Ja | Länge 3–40 | |
notes | string | Nein | Ja | max. 500 Zeichen | |
extras | array of ExtraSelectionDto | Nein | Ja | – | |
extras[].extraId | string | Ja | – | – | |
extras[].quantity | integer (int32) | Ja | – | min. 1 max. 100 | |
durationMinutes | integer (int32) | Nein | Ja | min. 15 max. 1440 | |
children | integer (int32) | Nein | Ja | min. 0 max. 199 | How many of int UpdateOperatorReservationRequest.PartySize are children (issue #554). int UpdateOperatorReservationRequest.PartySize stays the total head count and the only capacity input, so adults are PartySize - Children; at least one adult must remain. Null leaves the booking's current number of children untouched (clamped so one adult remains). Refused while the venue has switched the "ask for children" setting off. |
highChairs | integer (int32) | Nein | Ja | min. 0 max. 199 | High chairs reserved (issue #555). Null leaves the booking's current number untouched (clamped to its children). |
Antworten
- 200 OK
POST /api/operator/venue/reservations/{reference}/assign-table
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
reference | path | string | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
resourceId | string | Ja | – | – | The id of the restaurant table to seat the booking at. |
Antworten
- 200 OK
POST /api/operator/venue/reservations/{reference}/refund
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
reference | path | string | Ja | – | – |
Antworten
- 200 OK
POST /api/operator/venue/reservations/{reference}/status
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
reference | path | string | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
status | ReservationStatus | Ja | – | einer von: Pending, Confirmed, Cancelled, Completed, NoShow, PaidButUnavailable | Lifecycle status of a reservation. |
Antworten
- 200 OK
GET /api/operator/venue/resource-blocks
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
POST /api/operator/venue/resource-blocks
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
resourceId | string | Nein | Ja | – | Code of the resource to block (required on create). |
from | string | Nein | Ja | – | First blocked date ("yyyy-MM-dd"), or null for no start bound. |
to | string | Nein | Ja | – | Last blocked date ("yyyy-MM-dd"), or null for no end bound. |
days | array of DayOfWeek | Nein | Ja | einer von: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday | Weekdays; null or empty means every day. |
startTime | string | Nein | Ja | – | Start of the daily window ("HH:mm"); give both times or neither. |
endTime | string | Nein | Ja | – | End of the daily window ("HH:mm"); at or before the start it runs past midnight. |
seats | integer (int32) | Nein | Ja | – | Seats to block on a seat-sold resource; null blocks the whole resource. |
note | string | Nein | Ja | – | The operator's own reminder (at most 200 characters). |
Antworten
- 200 OK
PUT /api/operator/venue/resource-blocks/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
resourceId | string | Nein | Ja | – | Code of the resource to block (required on create). |
from | string | Nein | Ja | – | First blocked date ("yyyy-MM-dd"), or null for no start bound. |
to | string | Nein | Ja | – | Last blocked date ("yyyy-MM-dd"), or null for no end bound. |
days | array of DayOfWeek | Nein | Ja | einer von: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday | Weekdays; null or empty means every day. |
startTime | string | Nein | Ja | – | Start of the daily window ("HH:mm"); give both times or neither. |
endTime | string | Nein | Ja | – | End of the daily window ("HH:mm"); at or before the start it runs past midnight. |
seats | integer (int32) | Nein | Ja | – | Seats to block on a seat-sold resource; null blocks the whole resource. |
note | string | Nein | Ja | – | The operator's own reminder (at most 200 characters). |
Antworten
- 200 OK
DELETE /api/operator/venue/resource-blocks/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/venue/resource-groups
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
POST /api/operator/venue/resource-groups
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
name | string | Ja | – | – | |
description | string | Ja | – | – |
Antworten
- 200 OK
PUT /api/operator/venue/resource-groups/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
name | string | Ja | – | – | |
description | string | Ja | – | – | |
ordinal | integer (int32) | Ja | – | – |
Antworten
- 200 OK
DELETE /api/operator/venue/resource-groups/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/venue/resources
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
POST /api/operator/venue/resources
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
name | string | Ja | – | – | |
type | BookableResourceType | Ja | – | einer von: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar | The kinds of bookable resource a venue can publish. A restaurant table booking uses the same reservation model as a billiard or dart booking; only the type and pricing rules differ. |
capacity | integer (int32) | Ja | – | – | |
description | string | Ja | – | – | |
slotDurationMinutes | integer (int32) | Ja | Ja | – | Booking slot duration in minutes, or null to inherit the venue's default for the type. Unlike bool? SaveResourceRequest.AllowsFoodOrdering and bool? SaveResourceRequest.SeatSold, null here is a fully-specified, always-applied value ("inherit the policy") on both create and update — there is no create/update ambiguity to resolve, so this field is applied unconditionally. |
pricing | ResourcePricingDto | Ja | – | – | Pricing details for a bookable resource. |
pricing.model | PricingModel | Ja | – | einer von: Free, PerHour, PerGame, PerSession, FixedFee, Deposit, MinimumSpend | How a bookable resource is priced. |
pricing.amount | number (double) | Ja | – | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
pricing.currency | string | Ja | – | – | |
pricing.depositAmount | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
pricing.minimumSpend | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
pricing.unitLabel | string | Ja | – | – | |
pricing.childAmount | number (double) | Nein | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | What a child pays where the price scales with people (PricingModel.PerGame), in Currency (#556): 0 means children are free, null that a child pays Amount like an adult. Ignored for the models that charge once per booking. Defaulted so pre-existing payloads still bind. |
pricing.depositPerPerson | boolean | Nein | – | Standard false | Whether DepositAmount is charged per person instead of once per booking (#556). False for every pre-existing resource and payload. |
pricing.childDepositAmount | number (double) | Nein | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | What a child pays towards a per-person deposit (#556): 0 means children are free, null that a child pays DepositAmount. Only meaningful with DepositPerPerson. |
allowsFoodOrdering | boolean | Ja | Ja | – | |
seatSold | boolean | Nein | Ja | – | Whether the resource is sold by the seat instead of booked exclusively — see bool BookableResourceDto.SeatSold. |
Antworten
- 200 OK
PUT /api/operator/venue/resources/{code}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
code | path | string | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
name | string | Ja | – | – | |
type | BookableResourceType | Ja | – | einer von: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar | The kinds of bookable resource a venue can publish. A restaurant table booking uses the same reservation model as a billiard or dart booking; only the type and pricing rules differ. |
capacity | integer (int32) | Ja | – | – | |
description | string | Ja | – | – | |
slotDurationMinutes | integer (int32) | Ja | Ja | – | Booking slot duration in minutes, or null to inherit the venue's default for the type. Unlike bool? SaveResourceRequest.AllowsFoodOrdering and bool? SaveResourceRequest.SeatSold, null here is a fully-specified, always-applied value ("inherit the policy") on both create and update — there is no create/update ambiguity to resolve, so this field is applied unconditionally. |
pricing | ResourcePricingDto | Ja | – | – | Pricing details for a bookable resource. |
pricing.model | PricingModel | Ja | – | einer von: Free, PerHour, PerGame, PerSession, FixedFee, Deposit, MinimumSpend | How a bookable resource is priced. |
pricing.amount | number (double) | Ja | – | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
pricing.currency | string | Ja | – | – | |
pricing.depositAmount | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
pricing.minimumSpend | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
pricing.unitLabel | string | Ja | – | – | |
pricing.childAmount | number (double) | Nein | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | What a child pays where the price scales with people (PricingModel.PerGame), in Currency (#556): 0 means children are free, null that a child pays Amount like an adult. Ignored for the models that charge once per booking. Defaulted so pre-existing payloads still bind. |
pricing.depositPerPerson | boolean | Nein | – | Standard false | Whether DepositAmount is charged per person instead of once per booking (#556). False for every pre-existing resource and payload. |
pricing.childDepositAmount | number (double) | Nein | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | What a child pays towards a per-person deposit (#556): 0 means children are free, null that a child pays DepositAmount. Only meaningful with DepositPerPerson. |
allowsFoodOrdering | boolean | Ja | Ja | – | |
seatSold | boolean | Nein | Ja | – | Whether the resource is sold by the seat instead of booked exclusively — see bool BookableResourceDto.SeatSold. |
Antworten
- 200 OK
DELETE /api/operator/venue/resources/{code}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
code | path | string | Ja | – | – |
Antworten
- 200 OK
PUT /api/operator/venue/resources/{code}/group
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
code | path | string | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
resourceGroupId | string (uuid) | Ja | Ja | – |
Antworten
- 200 OK
GET /api/operator/venue/shifts
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
from | query | string (date) | Nein | – | – |
to | query | string (date) | Nein | – | – |
memberId | query | string (uuid) | Nein | – | – |
Antworten
- 200 OK
POST /api/operator/venue/shifts
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
memberId | string (uuid) | Ja | – | – | |
date | string (date) | Ja | – | – | |
startTime | string (time) | Ja | – | – | |
endTime | string (time) | Ja | – | – | |
note | string | Nein | Ja | – |
Antworten
- 200 OK
GET /api/operator/venue/shifts/mine
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
PUT /api/operator/venue/shifts/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
memberId | string (uuid) | Ja | – | – | |
date | string (date) | Ja | – | – | |
startTime | string (time) | Ja | – | – | |
endTime | string (time) | Ja | – | – | |
note | string | Nein | Ja | – |
Antworten
- 200 OK
DELETE /api/operator/venue/shifts/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/venue/specials
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
archived | query | boolean | Nein | – | Standard false |
Antworten
- 200 OK
POST /api/operator/venue/specials
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
kind | SpecialKind | Ja | – | einer von: Dish, MenuItem | Dish or a discount on a menu item. |
status | SpecialStatus | Ja | – | einer von: Draft, Published, Archived | Draft, live or archived. |
title | string | Ja | – | – | The headline. |
description | string | Ja | Ja | – | Optional description. |
imageUrl | string | Ja | Ja | – | The special's own image. |
price | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | Required for a Dish (400 PriceRequired); on a menu-item special null means the item's own price. |
taxRate | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | The tax rate; null means none recorded (a menu-item special inherits the item's). |
menuItemId | string | Ja | Ja | – | The referenced menu item's id, if any. |
sortOrder | integer (int32) | Ja | – | – | Manual order among specials. |
startsOn | string (date) | Ja | Ja | – | First day it runs; null means no lower bound. |
endsOn | string (date) | Ja | Ja | – | Last day it runs; null means no upper bound. |
weekdays | array of DayOfWeek | Ja | Ja | einer von: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday | Days of the week it runs on; null or empty means every day. |
windowStart | string (time) | Ja | Ja | – | Start of the daily window; null means all day. One side alone is refused. |
windowEnd | string (time) | Ja | Ja | – | End of the daily window; null means all day. One side alone is refused. |
Antworten
- 200 OK
GET /api/operator/venue/specials/days
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
date | query | string | Nein | – | – |
days | query | string | Nein | – | – |
Antworten
- 200 OK
POST /api/operator/venue/specials/preview
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
date | string (date) | Ja | – | – | The day to preview. |
draft | SaveSpecialRequest | Nein | Ja | – | Body of POST and PUT /api/operator/venue/specials. A full replace: every member is applied as sent, an omitted status binds Draft (unpublishing the special) and an omitted kind binds Dish, so always send both. Null on the optional members is a complete answer, never "leave the stored value". |
draft.kind | SpecialKind | Ja | – | einer von: Dish, MenuItem | Dish or a discount on a menu item. |
draft.status | SpecialStatus | Ja | – | einer von: Draft, Published, Archived | Draft, live or archived. |
draft.title | string | Ja | – | – | The headline. |
draft.description | string | Ja | Ja | – | Optional description. |
draft.imageUrl | string | Ja | Ja | – | The special's own image. |
draft.price | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | Required for a Dish (400 PriceRequired); on a menu-item special null means the item's own price. |
draft.taxRate | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | The tax rate; null means none recorded (a menu-item special inherits the item's). |
draft.menuItemId | string | Ja | Ja | – | The referenced menu item's id, if any. |
draft.sortOrder | integer (int32) | Ja | – | – | Manual order among specials. |
draft.startsOn | string (date) | Ja | Ja | – | First day it runs; null means no lower bound. |
draft.endsOn | string (date) | Ja | Ja | – | Last day it runs; null means no upper bound. |
draft.weekdays | array of DayOfWeek | Ja | Ja | einer von: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday | Days of the week it runs on; null or empty means every day. |
draft.windowStart | string (time) | Ja | Ja | – | Start of the daily window; null means all day. One side alone is refused. |
draft.windowEnd | string (time) | Ja | Ja | – | End of the daily window; null means all day. One side alone is refused. |
draftId | string (uuid) | Nein | Ja | – | The id of a stored special the draft replaces. |
Antworten
- 200 OK
GET /api/operator/venue/specials/print
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
date | query | string | Nein | – | – |
days | query | string | Nein | – | – |
paper | query | string | Nein | – | – |
lang | query | string | Nein | – | – |
Antworten
- 200 OK
GET /api/operator/venue/specials/settings
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
PUT /api/operator/venue/specials/settings
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
any
Antworten
- 200 OK
GET /api/operator/venue/specials/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
PUT /api/operator/venue/specials/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
kind | SpecialKind | Ja | – | einer von: Dish, MenuItem | Dish or a discount on a menu item. |
status | SpecialStatus | Ja | – | einer von: Draft, Published, Archived | Draft, live or archived. |
title | string | Ja | – | – | The headline. |
description | string | Ja | Ja | – | Optional description. |
imageUrl | string | Ja | Ja | – | The special's own image. |
price | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | Required for a Dish (400 PriceRequired); on a menu-item special null means the item's own price. |
taxRate | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | The tax rate; null means none recorded (a menu-item special inherits the item's). |
menuItemId | string | Ja | Ja | – | The referenced menu item's id, if any. |
sortOrder | integer (int32) | Ja | – | – | Manual order among specials. |
startsOn | string (date) | Ja | Ja | – | First day it runs; null means no lower bound. |
endsOn | string (date) | Ja | Ja | – | Last day it runs; null means no upper bound. |
weekdays | array of DayOfWeek | Ja | Ja | einer von: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday | Days of the week it runs on; null or empty means every day. |
windowStart | string (time) | Ja | Ja | – | Start of the daily window; null means all day. One side alone is refused. |
windowEnd | string (time) | Ja | Ja | – | End of the daily window; null means all day. One side alone is refused. |
Antworten
- 200 OK
DELETE /api/operator/venue/specials/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/venue/staff-access-grants
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
memberId | query | string (uuid) | Nein | – | – |
Antworten
- 200 OK
POST /api/operator/venue/staff-access-grants
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
memberId | string (uuid) | Ja | – | – | |
minutes | integer (int32) | Ja | – | – | |
reason | string | Nein | Ja | – |
Antworten
- 200 OK
DELETE /api/operator/venue/staff-access-grants/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/venue/staff-access-policy
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
PUT /api/operator/venue/staff-access-policy
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
bufferBeforeMinutes | integer (int32) | Ja | – | – | |
bufferAfterMinutes | integer (int32) | Ja | – | – |
Antworten
- 200 OK
PUT /api/operator/venue/station-routes
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
routes | array of StationRouteDto | Ja | – | – | |
routes[].stationId | string (uuid) | Ja | – | – | |
routes[].menuId | string | Ja | – | – | |
routes[].groupName | string | Nein | Ja | – | |
routes[].menuItemId | string | Nein | Ja | – |
Antworten
- 200 OK
GET /api/operator/venue/stations
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
POST /api/operator/venue/stations
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
name | string | Ja | – | – | 1 to 40 characters, unique at the venue (case-insensitive). |
sortOrder | integer (int32) | Nein | – | Standard 0 | Where the station is listed; lower first. |
Antworten
- 200 OK
PUT /api/operator/venue/stations/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
name | string | Ja | – | – | 1 to 40 characters, unique at the venue (case-insensitive). |
sortOrder | integer (int32) | Nein | – | Standard 0 | Where the station is listed; lower first. |
Antworten
- 200 OK
DELETE /api/operator/venue/stations/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/venue/table-merges
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
POST /api/operator/venue/table-merges
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
name | string | Ja | – | – | |
resourceCodes | array of string | Ja | – | – | |
capacity | integer (int32) | Ja | – | – |
Antworten
- 200 OK
PUT /api/operator/venue/table-merges/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
name | string | Ja | – | – | |
resourceCodes | array of string | Ja | – | – | |
capacity | integer (int32) | Ja | – | – |
Antworten
- 200 OK
DELETE /api/operator/venue/table-merges/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/venue/team/{memberId}/notification-preferences
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
memberId | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
PUT /api/operator/venue/team/{memberId}/notification-preferences
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
memberId | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
newBookings | boolean | Ja | – | – | |
bookingRequests | boolean | Ja | – | – | |
cancellations | boolean | Ja | – | – | |
guestMessages | boolean | Ja | – | – | |
allOrders | boolean | Ja | – | – | |
orderStationIds | array of string (uuid) | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/venue/unassigned-bookings
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
PUT /api/operator/venue/unassigned-bookings
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
any
Antworten
- 200 OK
GET /api/operator/venue/voucher-settings
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
PUT /api/operator/venue/voucher-settings
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
onlineSaleEnabled | boolean | Ja | – | – | |
validity | VoucherValidityDto | Ja | Ja | – | How long the venue's vouchers are valid. Exactly the member Mode needs is set: Months (1–360), FixedDate (yyyy-MM-dd) or Years (0–30, the year-end rule: 31 December of the issue year plus that many years). |
validity.mode | VoucherValidityMode | Ja | – | einer von: Months, FixedDate, YearEndAfterYears | How a venue's voucher validity rule computes an expiry date from the issue date. |
validity.months | integer (int32) | Ja | Ja | – | |
validity.fixedDate | string | Ja | Ja | – | |
validity.years | integer (int32) | Ja | Ja | – | |
products | array of VoucherProductDto | Ja | – | – | |
products[].id | string | Ja | Ja | – | Null for a new product, which the server mints an id for; a known id is preserved. |
products[].kind | VoucherKind | Ja | – | einer von: Amount, Percentage, Item | What a voucher is worth, and so how it redeems. |
products[].titleEn | string | Ja | – | – | |
products[].titleDe | string | Ja | Ja | – | |
products[].vatClassification | VoucherVatClassification | Ja | Ja | einer von: SinglePurpose, MultiPurpose | |
products[].amount | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | VoucherKind.Amount with a fixed value: the value and the sale price. |
products[].customAmount | boolean | Ja | – | – | VoucherKind.Amount: the buyer picks the value within MinAmount–MaxAmount. |
products[].minAmount | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
products[].maxAmount | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
products[].percentage | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
products[].maxDiscount | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
products[].menuItemId | string | Ja | Ja | – | VoucherKind.Item: the menu item's stable id; it must exist in the venue's menus. |
products[].menuItemName | string | Ja | Ja | – | Ignored on save: the server snapshots the menu item's current name. |
products[].salePrice | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | The online sale price of a percentage or item product; required when it is sold online. |
products[].sellOnline | boolean | Ja | – | – | |
products[].active | boolean | Ja | – | – | |
products[].sortOrder | integer (int32) | Ja | – | – | |
termsEn | string | Ja | Ja | – | |
termsDe | string | Ja | Ja | – |
Antworten
- 200 OK
GET /api/operator/venue/vouchers
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
search | query | string | Nein | – | – |
status | query | string | Nein | – | – |
page | query | integer (int32) | Nein | – | – |
pageSize | query | integer (int32) | Nein | – | – |
Antworten
- 200 OK
POST /api/operator/venue/vouchers
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
productId | string | Ja | Ja | – | Issue from one of the venue's products; its kind, value and VAT classification are used and the ad-hoc members below are ignored. Null issues ad hoc from Kind. |
kind | VoucherKind | Ja | Ja | einer von: Amount, Percentage, Item | What a voucher is worth, and so how it redeems. |
amount | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | Ad hoc VoucherKind.Amount, or the value of a custom-amount product. |
percentage | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
maxDiscount | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
menuItemId | string | Ja | Ja | – | Ad hoc VoucherKind.Item: the menu item's stable id. |
vatClassification | VoucherVatClassification | Ja | Ja | einer von: SinglePurpose, MultiPurpose | |
payment | VoucherManualPayment | Ja | – | einer von: Cash, CardAtTill, NotPaid | How the voucher was paid at the venue; VoucherManualPayment.NotPaid for a promo or goodwill voucher. |
pricePaid | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | What was taken at the till; required unless Payment is VoucherManualPayment.NotPaid. |
expiresOn | string | Ja | Ja | – | Overrides the venue's validity rule (yyyy-MM-dd). A paid voucher must be valid for at least one year. |
recipientName | string | Ja | Ja | – | |
recipientEmail | string | Ja | Ja | – | |
giftMessage | string | Ja | Ja | – | |
language | string | Ja | Ja | – | "en" or "de": the language of the terms snapshot. Defaults to the venue's. |
Antworten
- 200 OK
POST /api/operator/venue/vouchers/lookup
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
code | string | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/venue/vouchers/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
PUT /api/operator/venue/vouchers/{id}/expiry
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
expiresOn | string | Ja | – | – | |
reason | string | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/venue/vouchers/{id}/printable
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
POST /api/operator/venue/vouchers/{id}/redemptions
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
amount | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
billTotal | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
tabSessionId | string (uuid) | Ja | Ja | – | Apply to this open QR ordering tab (the operator board's Guid? TableTabDto.SessionId): the redemption is credited against the tab, so its amount due and the voucher stay consistent. Null redeems against a bill outside BookDinePlay. |
tabLineIndex | integer (int32) | Ja | Ja | – | Item vouchers on a tab: the zero-based index into the tab's lines (IReadOnlyList<TabLineDto>? TableTabDto.Lines / IReadOnlyList<TabLineDto> TableSessionResponse.Tab). |
billReference | string | Ja | Ja | – | Optional free text from staff (at most 80 characters), e.g. the till receipt number. |
tabLineItemName | string | Nein | Ja | – | Item vouchers on a tab: the item name of the line staff picked, as they saw it. When given, a line at TabLineIndex with another name is refused rather than credited — the tab may have changed (an order cancelled) since the screen loaded. |
Antworten
- 200 OK
POST /api/operator/venue/vouchers/{id}/redemptions/{transactionId}/reverse
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
transactionId | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
reason | string | Ja | Ja | – |
Antworten
- 200 OK
POST /api/operator/venue/vouchers/{id}/refund
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
POST /api/operator/venue/vouchers/{id}/resend
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
POST /api/operator/venue/vouchers/{id}/void
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
reason | string | Ja | – | – |
Antworten
- 200 OK
POST /api/operator/venue/zones
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
name | string | Ja | – | – |
Antworten
- 200 OK
PUT /api/operator/venue/zones/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
name | string | Ja | – | – | |
ordinal | integer (int32) | Ja | – | – |
Antworten
- 200 OK
DELETE /api/operator/venue/zones/{id}
Braucht ein Auth0-Bearer-Token.
Parameter
| Name | Ort | Typ | Pflicht | Null erlaubt | Einschränkungen |
|---|---|---|---|---|---|
id | path | string (uuid) | Ja | – | – |
Antworten
- 200 OK
GET /api/operator/venues
Braucht ein Auth0-Bearer-Token.
Antworten
- 200 OK
POST /api/operator/venues
Braucht ein Auth0-Bearer-Token.
Anfrage-Body application/json
| Feld | Typ | Pflicht | Null erlaubt | Einschränkungen | Beschreibung |
|---|---|---|---|---|---|
slug | string | Ja | – | – | |
name | string | Ja | – | – | |
tagline | string | Ja | – | – | |
description | string | Ja | – | – | |
city | string | Ja | – | – | |
country | string | Ja | – | – | |
timezone | string | Ja | – | – | |
businessProfile | BusinessProfileDto | Ja | – | – | Venue business profile (address + contact), for the operator's edit surface. |
businessProfile.legalName | string | Ja | – | – | |
businessProfile.addressLine1 | string | Ja | – | – | |
businessProfile.addressLine2 | string | Ja | Ja | – | |
businessProfile.city | string | Ja | – | – | |
businessProfile.postalCode | string | Ja | – | – | |
businessProfile.country | string | Ja | – | – | |
businessProfile.phone | string | Ja | – | – | |
businessProfile.email | string | Ja | – | – | |
businessProfile.website | string | Ja | Ja | – | |
paymentPolicy | PaymentPolicyDto | Ja | – | – | Venue payment policy, for the operator's edit surface. |
paymentPolicy.paymentsEnabled | boolean | Ja | – | – | |
paymentPolicy.depositsEnabled | boolean | Ja | – | – | |
paymentPolicy.currency | string | Ja | – | – | |
paymentPolicy.defaultDepositAmount | number (double) | Ja | Ja | Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ | |
preferredLanguage | string | Nein | – | Standard en |
Antworten
- 200 OK
Problemtypen
Jeder Problem-type der Form https://bookdineplay.com/docs/api/errors/<reason> landet im gleichnamigen Abschnitt der Fehlerseite.