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

Operation: ListVenueDirectory

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

NameOrtTypPflichtNull erlaubtEinschränkungen
queryquerystringNein––
cityquerystringNein––
pagequeryinteger (int32)Nein––
pageSizequeryinteger (int32)Nein––

Antworten

  • 200 OK

Problemtypen

Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:

Alle Problemtypen

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}

Operation: GetVenue

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

NameOrtTypPflichtNull erlaubtEinschränkungen
venueSlugpathstringJa––

Antworten

  • 200 OK

Problemtypen

Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:

Alle Problemtypen

Ausprobieren

Sendet eine echte Anfrage aus Ihrem Browser an die Demo-Location, mit einem veröffentlichbaren Demo-Schlüssel.

GET /api/venues/{venueSlug}/availability

Operation: GetAvailability

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

NameOrtTypPflichtNull erlaubtEinschränkungen
venueSlugpathstringJa––
datequerystringJa––
partySizequeryinteger (int32)Nein–Standard 2
resourceTypequeryBookableResourceTypeNein–Standard RestaurantTable
einer von: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar
durationMinutesqueryinteger (int32)Nein––
groupByquerystringNein––
resourceGroupquerystring (uuid)Nein––
childrenqueryinteger (int32)Nein–Standard 0
includePreviousNightquerybooleanNein–Standard false

Antworten

  • 200 OK

Problemtypen

Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:

Alle Problemtypen

Ausprobieren

Sendet eine echte Anfrage aus Ihrem Browser an die Demo-Location, mit einem veröffentlichbaren Demo-Schlüssel.

GET /api/venues/{venueSlug}/business-info

Operation: GetBusinessInfo

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

NameOrtTypPflichtNull erlaubtEinschränkungen
venueSlugpathstringJa––

Antworten

  • 200 OK

Problemtypen

Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:

Alle Problemtypen

Ausprobieren

Sendet eine echte Anfrage aus Ihrem Browser an die Demo-Location, mit einem veröffentlichbaren Demo-Schlüssel.

GET /api/venues/{venueSlug}/floor-plan

Operation: GetFloorPlan

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

NameOrtTypPflichtNull erlaubtEinschränkungen
venueSlugpathstringJa––

Antworten

  • 200 OK

Problemtypen

Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:

Alle Problemtypen

Ausprobieren

Sendet eine echte Anfrage aus Ihrem Browser an die Demo-Location, mit einem veröffentlichbaren Demo-Schlüssel.

GET /api/venues/{venueSlug}/menus

Operation: GetMenus

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

NameOrtTypPflichtNull erlaubtEinschränkungen
venueSlugpathstringJa––

Antworten

  • 200 OK

Problemtypen

Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:

Alle Problemtypen

Ausprobieren

Sendet eine echte Anfrage aus Ihrem Browser an die Demo-Location, mit einem veröffentlichbaren Demo-Schlüssel.

GET /api/venues/{venueSlug}/opening-hours

Operation: GetOpeningHours

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

NameOrtTypPflichtNull erlaubtEinschränkungen
venueSlugpathstringJa––

Antworten

  • 200 OK

Problemtypen

Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:

Alle Problemtypen

Ausprobieren

Sendet eine echte Anfrage aus Ihrem Browser an die Demo-Location, mit einem veröffentlichbaren Demo-Schlüssel.

POST /api/venues/{venueSlug}/payment-intents

Operation: CreatePaymentIntent

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

NameOrtTypPflichtNull erlaubtEinschränkungen
venueSlugpathstringJa––

Anfrage-Body application/json

CreatePaymentIntentRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
reservationReferencestringJa––
amountnumber (double)Ja–min. 0.01
max. 100000
Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
currencystringJa–Länge 3–3
providerstringNeinJa–Optional provider key. Only the local "fake" provider is available in the first milestone.
voucherCodestringNeinJamax. 64 ZeichenA 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:

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/venues/{venueSlug}/reservations

Operation: CreateReservation

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

NameOrtTypPflichtNull erlaubtEinschränkungen
venueSlugpathstringJa––
Idempotency-KeyheaderstringNein––

Anfrage-Body application/json

CreateReservationRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
resourceTypeBookableResourceTypeJa–einer von: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, BarThe 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.
resourceIdstringNeinJa–Optional specific resource id. When omitted the service picks the first available resource of the type.
datestringJa––Venue-local date, "yyyy-MM-dd".
startstringJa––Venue-local start time, "HH:mm".
endstringNeinJa–Optional venue-local end time, "HH:mm". Defaults to the resource slot length.
partySizeinteger (int32)Ja–min. 1
max. 200
gamesinteger (int32)NeinJamin. 1
max. 10
How many games to book, for resources priced per game. Defaults to 1 when omitted.
customerNamestringJa–Länge 2–120
emailstringJa–max. 256 ZeichenBounded 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).
phonestringNeinJaLänge 3–40Optional. 3–40 characters when supplied; blank is treated as not supplied.
notesstringNeinJamax. 500 Zeichen
depositOptInbooleanNein––Whether the guest opts in to an optional deposit (only offered when the venue enables deposits).
extrasarray of ExtraSelectionDtoNeinJa–Optional extras the guest wants added to the booking, e.g. shoe rental.
extras[].extraIdstringJa––
extras[].quantityinteger (int32)Ja–min. 1
max. 100
durationMinutesinteger (int32)NeinJamin. 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.
childreninteger (int32)NeinJamin. 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.
highChairsinteger (int32)NeinJamin. 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:

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/venues/{venueSlug}/resources

Operation: GetResources

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

NameOrtTypPflichtNull erlaubtEinschränkungen
venueSlugpathstringJa––

Antworten

  • 200 OK

Problemtypen

Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:

Alle Problemtypen

Ausprobieren

Sendet eine echte Anfrage aus Ihrem Browser an die Demo-Location, mit einem veröffentlichbaren Demo-Schlüssel.

GET /api/venues/{venueSlug}/events

Operation: GetEvents

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

NameOrtTypPflichtNull erlaubtEinschränkungen
venueSlugpathstringJa––
upcomingquerybooleanNein–Standard true

Antworten

  • 200 OK

Problemtypen

Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:

Alle Problemtypen

Ausprobieren

Sendet eine echte Anfrage aus Ihrem Browser an die Demo-Location, mit einem veröffentlichbaren Demo-Schlüssel.

GET /api/venues/{venueSlug}/events/{eventSlug}

Operation: GetEvent

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

NameOrtTypPflichtNull erlaubtEinschränkungen
venueSlugpathstringJa––
eventSlugpathstringJa––

Antworten

  • 200 OK

Problemtypen

Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:

Alle Problemtypen

Ausprobieren

Sendet eine echte Anfrage aus Ihrem Browser an die Demo-Location, mit einem veröffentlichbaren Demo-Schlüssel.

POST /api/venues/{venueSlug}/events/{eventSlug}/registrations

Operation: RegisterForEvent

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

NameOrtTypPflichtNull erlaubtEinschränkungen
venueSlugpathstringJa––
eventSlugpathstringJa––
Idempotency-KeyheaderstringNein––

Anfrage-Body application/json

EventRegistrationRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
buyerNamestringJa–max. 120 Zeichen
emailstringJa–max. 256 Zeichen
phonestringNeinJamax. 40 ZeichenOptional. Blank is treated as not supplied.
notesstringNeinJamax. 1000 Zeichen
quantityinteger (int32)Ja–min. 1
max. 100
How many tickets. Must not exceed the event's maxPerRegistration or its remaining capacity.
attendeesarray of stringNein––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.
childreninteger (int32)NeinJamin. 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:

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/venues/{venueSlug}/events/{eventSlug}/tickets/checkout

Operation: CheckoutEventTickets

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

NameOrtTypPflichtNull erlaubtEinschränkungen
venueSlugpathstringJa––
eventSlugpathstringJa––
Idempotency-KeyheaderstringNein––

Anfrage-Body application/json

EventTicketCheckoutRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
buyerNamestringJa–max. 120 Zeichen
emailstringJa–max. 256 Zeichen
phonestringNeinJamax. 40 ZeichenOptional. Blank is treated as not supplied.
notesstringNeinJamax. 1000 Zeichen
quantityinteger (int32)Ja–min. 1
max. 100
How many tickets. Must not exceed the event's maxPerRegistration or its remaining capacity.
attendeesarray of stringNein––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.
successUrlstringNeinJa–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).
cancelUrlstringNeinJa–Where the guest lands if they abandon Checkout. Same rule as string? EventTicketCheckoutRequest.SuccessUrl (errors.cancelUrl on failure).
voucherCodestringNeinJamax. 200 ZeichenOptional. 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.
childreninteger (int32)NeinJamin. 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:

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/venues/{venueSlug}/specials

Operation: GetSpecials

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

NameOrtTypPflichtNull erlaubtEinschränkungen
venueSlugpathstringJa––
datequerystringNein––
daysqueryinteger (int32)Nein–Standard 1

Antworten

  • 200 OK

Problemtypen

Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:

Alle Problemtypen

Ausprobieren

Sendet eine echte Anfrage aus Ihrem Browser an die Demo-Location, mit einem veröffentlichbaren Demo-Schlüssel.

POST /api/venues/{venueSlug}/vouchers/checkout

Operation: StartVoucherCheckout

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

NameOrtTypPflichtNull erlaubtEinschränkungen
venueSlugpathstringJa––
Idempotency-KeyheaderstringNein––

Anfrage-Body application/json

StartVoucherCheckoutRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
productIdstringJa–max. 32 ZeichenThe product to buy (string VoucherOfferDto.ProductId).
amountnumber (double)NeinJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$A custom-amount product only: the value to buy, within its minimum and maximum.
buyerNamestringJa–max. 120 Zeichen
buyerEmailstringJa–max. 256 ZeichenWhere the receipt and — without a recipient e-mail — the voucher itself are sent.
recipientNamestringNeinJamax. 120 Zeichen
recipientEmailstringNeinJamax. 256 ZeichenSends the voucher to the recipient directly (on string? StartVoucherCheckoutRequest.DeliverOn, or at once).
giftMessagestringNeinJamax. 500 Zeichen
deliverOnstringNeinJa–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.
languagestringNeinJa–"en" or "de": the voucher's and the e-mails' language. Defaults to the request's language.
successUrlstringNeinJa–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.
cancelUrlstringNeinJa–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:

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/venues/{venueSlug}/vouchers/offers

Operation: GetVoucherOffers

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

NameOrtTypPflichtNull erlaubtEinschränkungen
venueSlugpathstringJa––

Antworten

  • 200 OK

Problemtypen

Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:

Alle Problemtypen

Ausprobieren

Sendet eine echte Anfrage aus Ihrem Browser an die Demo-Location, mit einem veröffentlichbaren Demo-Schlüssel.

POST /api/event-registrations/{cancelToken}/cancel

Operation: CancelEventRegistration

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

NameOrtTypPflichtNull erlaubtEinschränkungen
cancelTokenpathstringJa––

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

NameOrtTypPflichtNull erlaubtEinschränkungen
tokenpathstringJa––

Antworten

  • 200 OK

Problemtypen

Wird mit einem RFC-7807-Problem abgelehnt; die type-URL führt zur Erklärung. Alle Problemtypen.

Ausprobieren

Sendet eine echte Anfrage aus Ihrem Browser. Tragen Sie das Credential aus der erhaltenen URL ein; es wird kein Schlüssel gesendet.

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

NameOrtTypPflichtNull erlaubtEinschränkungen
tokenpathstringJa––

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

NameOrtTypPflichtNull erlaubtEinschränkungen
tokenpathstringJa––

Anfrage-Body application/json

PlaceOrderRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
linesarray of OrderLineRequestJa––
lines[].menuIdstringJa––
lines[].itemNamestringJa––
lines[].quantityinteger (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

NameOrtTypPflichtNull erlaubtEinschränkungen
tokenpathstringJa––

Anfrage-Body application/json

TabPaymentRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
voucherCodestringNeinJamax. 200 ZeichenA 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

NameOrtTypPflichtNull erlaubtEinschränkungen
tokenpathstringJa––

Antworten

  • 200 OK

Problemtypen

Wird mit einem RFC-7807-Problem abgelehnt; die type-URL führt zur Erklärung. Alle Problemtypen.

Ausprobieren

Sendet eine echte Anfrage aus Ihrem Browser. Tragen Sie das Credential aus der erhaltenen URL ein; es wird kein Schlüssel gesendet.

GET /api/registrations/{cancelToken}

Operation: GetRegistration

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

NameOrtTypPflichtNull erlaubtEinschränkungen
cancelTokenpathstringJa––

Antworten

  • 200 OK

Problemtypen

Wird mit einem RFC-7807-Problem abgelehnt; die type-URL führt zur Erklärung. Alle Problemtypen.

Ausprobieren

Sendet eine echte Anfrage aus Ihrem Browser. Tragen Sie das Credential aus der erhaltenen URL ein; es wird kein Schlüssel gesendet.

GET /api/reservations/{cancelToken}

Operation: GetReservationByCancelToken

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

NameOrtTypPflichtNull erlaubtEinschränkungen
cancelTokenpathstringJa––

Antworten

  • 200 OK

Problemtypen

Wird mit einem RFC-7807-Problem abgelehnt; die type-URL führt zur Erklärung. Alle Problemtypen.

Ausprobieren

Sendet eine echte Anfrage aus Ihrem Browser. Tragen Sie das Credential aus der erhaltenen URL ein; es wird kein Schlüssel gesendet.

POST /api/reservations/{cancelToken}/cancel

Operation: CancelReservationByToken

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

NameOrtTypPflichtNull erlaubtEinschränkungen
cancelTokenpathstringJa––

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

Operation: SubscribeGuestPush

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

NameOrtTypPflichtNull erlaubtEinschränkungen
cancelTokenpathstringJa––

Anfrage-Body application/json

GuestPushRegistrationRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
deviceIdstringNeinJa–22 base64url characters as the server minted it, or null.

Antworten

  • 200 OK · application/json → GuestPushRegistrationResponse
    GuestPushRegistrationResponse
    FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
    enabledbooleanJa––False when push is not configured on the server: the client shows no opt-in and the other members are null.
    appIdstringJaJa–The public OneSignal App ID the SDK initialises with.
    externalIdstringJaJa–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.
    deviceIdstringJaJa–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

Operation: UnsubscribeGuestPush

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

NameOrtTypPflichtNull erlaubtEinschränkungen
cancelTokenpathstringJa––

Anfrage-Body application/json

GuestPushUnsubscribeRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
deviceIdstringJa––

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}

Operation: GetTicket

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

NameOrtTypPflichtNull erlaubtEinschränkungen
codepathstringJa––

Antworten

  • 200 OK

Problemtypen

Wird mit einem RFC-7807-Problem abgelehnt; die type-URL führt zur Erklärung. Alle Problemtypen.

Ausprobieren

Sendet eine echte Anfrage aus Ihrem Browser. Tragen Sie das Credential aus der erhaltenen URL ein; es wird kein Schlüssel gesendet.

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

NameOrtTypPflichtNull erlaubtEinschränkungen
venueSlugpathstringJa––

Anfrage-Body application/json

StartConversationRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
guestNamestringJa––
guestEmailstringJa––
subjectstringJa––
bodystringJa––

Antworten

  • 200 OK

Problemtypen

Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:

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/vouchers/{code}

Operation: GetGuestVoucher

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

NameOrtTypPflichtNull erlaubtEinschränkungen
codepathstringJa––

Antworten

  • 200 OK · application/json → GuestVoucherResponse
    GuestVoucherResponse
    FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
    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)JaJaMuster ^-?(?: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)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$The value an VoucherKind.Amount voucher was issued with.
    percentagenumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$A VoucherKind.Percentage voucher's discount, 0.01–100.
    maxDiscountnumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$The venue's optional cap on a percentage discount, in money.
    itemNamestringJaJa–An VoucherKind.Item voucher's menu item, as named at issue.
    expiresOnstringJa––The last valid day, venue-local, yyyy-MM-dd.
    termsstringJaJa–The venue's voucher terms as snapshotted at issue, in the voucher's language.
    recipientNamestringJaJa–
    giftMessagestringJaJa–
    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.

Ausprobieren

Sendet eine echte Anfrage aus Ihrem Browser. Tragen Sie das Credential aus der erhaltenen URL ein; es wird kein Schlüssel gesendet.

GET /api/venues/{venueSlug}/highlights

Operation: GetHighlights

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

NameOrtTypPflichtNull erlaubtEinschränkungen
venueSlugpathstringJa––

Antworten

  • 200 OK

Problemtypen

Wird mit einem RFC-7807-Problem abgelehnt, dessen type auf die Erklärung verweist:

Alle Problemtypen

Ausprobieren

Sendet eine echte Anfrage aus Ihrem Browser an die Demo-Location, mit einem veröffentlichbaren Demo-Schlüssel.

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

Operation: AdminResetDemoVenue

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
venueSlugpathstringJa––

Antworten

  • 200 OK
POST /api/admin/impersonate/{tenantId}

Operation: AdminImpersonateTenant

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
tenantIdpathstring (uuid)Ja––

Antworten

  • 200 OK
GET /api/admin/me

Operation: AdminMe

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
GET /api/admin/reservations

Operation: AdminReservations

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
venueSlugquerystringJa––
datequerystringJa––

Antworten

  • 200 OK
POST /api/admin/reservations/{venueSlug}/{reference}/status

Operation: AdminSetReservationStatus

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
venueSlugpathstringJa––
referencepathstringJa––

Anfrage-Body application/json

SetReservationStatusRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
statusReservationStatusJa–einer von: Pending, Confirmed, Cancelled, Completed, NoShow, PaidButUnavailableLifecycle status of a reservation.

Antworten

  • 200 OK
POST /api/admin/stripe/test-data-cleanup

Operation: AdminStripeTestDataCleanup

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
dryRunquerybooleanNein––

Antworten

  • 200 OK
GET /api/admin/tenants

Operation: AdminTenants

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
POST /api/admin/tenants

Operation: AdminCreateTenant

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

CreateTenantRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
namestringJa––
slugstringJa––
planPlanTierJa–einer von: Starter, Pro, PremiumSubscription 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}

Operation: AdminTenantById

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Antworten

  • 200 OK
PUT /api/admin/tenants/{id}

Operation: AdminUpdateTenant

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Anfrage-Body application/json

UpdateTenantRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
namestringJa––
planPlanTierJa–einer von: Starter, Pro, PremiumSubscription 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.
statusTenantStatusJa–einer von: Active, Suspended, PendingBillingLifecycle status of a tenant account.
billingBillingModeNeinJaeiner von: Manual, Stripe, AppStore, GooglePlay

Antworten

  • 200 OK
POST /api/admin/tenants/{id}/billing/resync

Operation: AdminResyncTenantBilling

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Antworten

  • 200 OK
GET /api/admin/tenants/{id}/operators

Operation: AdminGetTenantOperators

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Antworten

  • 200 OK
POST /api/admin/tenants/{id}/operators

Operation: AdminCreateTenantOperator

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Anfrage-Body application/json

CreateOperatorRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
emailstringJa––
displayNamestringJa––
auth0SubjectstringJa––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.
venueSlugstringNeinJa–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

Operation: AdminInviteTenantOperator

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Anfrage-Body application/json

InviteOperatorRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
emailstringJa––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.
displayNamestringJa––Shown in the console and the mail.
venueSlugstringNeinJa–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.
languagestringNeinJa–Optional mail language, en or de; omitted uses the tenant's UI language.

Antworten

  • 200 OK
PUT /api/admin/tenants/{id}/operators/{operatorId}

Operation: AdminUpdateTenantOperator

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––
operatorIdpathstring (uuid)Ja––

Anfrage-Body application/json

UpdateOperatorRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
displayNamestringJa––
auth0SubjectstringJa––

Antworten

  • 200 OK
PUT /api/admin/tenants/{id}/operators/{operatorId}/venue-access

Operation: AdminAssignOperatorVenue

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––
operatorIdpathstring (uuid)Ja––

Anfrage-Body application/json

AssignOperatorVenueRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
venueSlugstringJaJa–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

Operation: AdminGetTenantVenues

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Antworten

  • 200 OK
POST /api/onboarding

Operation: OnboardingCreate

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

OnboardingRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
tenantNamestringJa––
slugstringJa––
planPlanTierJa–einer von: Starter, Pro, PremiumSubscription 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.
emailstringJa––
displayNamestringJa––
companyCompanyProfileDtoNeinJa–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.legalNamestringJa––
company.addressLine1stringJa––
company.addressLine2stringJaJa–
company.postalCodestringJa––
company.citystringJa––
company.countrystringJa––ISO 3166-1 alpha-2 country code, e.g. "DE".
company.vatIdstringJaJa–Optional VAT identification number, e.g. "DE123456789"; format-checked only, never against a tax authority.
company.billingEmailstringJa––
company.contactNamestringJa––
intervalBillingIntervalNein–einer von: Monthly, YearlyMonthly or yearly billing for the chosen plan.
acceptancesarray of AcceptLegalDocumentDtoNeinJa–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[].kindLegalDocumentKindJa–einer von: Terms, DataProcessingAgreementA legal document BookDinePlay publishes in numbered versions and every operator accepts at sign-up (and again when a newer version takes effect).
acceptances[].versionstringJa––
acceptances[].languagestringJa––
uiLanguagestringNeinJa–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.
billingOnboardingBillingSourceNeinJaeiner von: Web, AppStore, GooglePlay

Antworten

  • 200 OK
GET /api/onboarding/slug-available

Operation: OnboardingSlugAvailable

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
slugquerystringNein––

Antworten

  • 200 OK
GET /api/onboarding/status

Operation: OnboardingStatus

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
DELETE /api/operator/account

Operation: OperatorDeleteAccount

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
GET /api/operator/billing

Operation: OperatorBillingSummary

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
POST /api/operator/billing/app-store/transactions

Operation: OperatorAttachAppStoreTransaction

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

AppStoreTransactionRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
signedTransactionstringJa––The JWS; empty when TransactionId is given instead.
transactionIdstringNeinJa–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

Operation: OperatorCompleteBillingCheckout

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

CheckoutReturnRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
sessionIdstringJa––

Antworten

  • 200 OK
POST /api/operator/billing/checkout-session

Operation: OperatorStartBillingCheckout

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

StartCheckoutRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
tierPlanTierJa–einer von: Starter, Pro, PremiumSubscription 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.
intervalBillingIntervalJa–einer von: Monthly, YearlyBilling cadence for a subscription.

Antworten

  • 200 OK
PUT /api/operator/billing/company

Operation: OperatorUpdateBillingCompany

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

CompanyProfileDto
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
legalNamestringJa––
addressLine1stringJa––
addressLine2stringJaJa–
postalCodestringJa––
citystringJa––
countrystringJa––ISO 3166-1 alpha-2 country code, e.g. "DE".
vatIdstringJaJa–Optional VAT identification number, e.g. "DE123456789"; format-checked only, never against a tax authority.
billingEmailstringJa––
contactNamestringJa––

Antworten

  • 200 OK
POST /api/operator/billing/google-play/purchases

Operation: OperatorAttachGooglePlayPurchase

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

GooglePlayPurchaseRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
purchaseTokenstringJa–max. 512 Zeichen
productIdstringNeinJamax. 100 Zeichen

Antworten

  • 200 OK
POST /api/operator/billing/portal-session

Operation: OperatorCreateBillingPortalSession

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

PortalSessionRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
intentstringJa––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.
tierPlanTierNeinJaeiner von: Starter, Pro, PremiumSubscription 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.
intervalBillingIntervalNeinJaeiner von: Monthly, YearlyBilling cadence for a subscription.

Antworten

  • 200 OK
GET /api/operator/billing/store

Operation: OperatorStoreBillingStatus

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
GET /api/operator/employees

Operation: OperatorEmployees

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
POST /api/operator/employees

Operation: OperatorCreateEmployee

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

CreateEmployeeRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
emailstringJa––
displayNamestringJa––
roleEmployeeRoleJa–einer von: Manager, StaffAn employee's role within a venue.

Antworten

  • 200 OK
POST /api/operator/employees/{id}/assignments

Operation: OperatorAssignResource

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Anfrage-Body application/json

AssignResourceRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
resourceIdstringJa––
resourceNamestringJa––
resourceTypeBookableResourceTypeJa–einer von: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, BarThe 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}

Operation: OperatorUnassignResource

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––
resourceIdpathstringJa––

Antworten

  • 200 OK
POST /api/operator/employees/{id}/status

Operation: OperatorSetEmployeeActive

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Anfrage-Body application/json

SetEmployeeActiveRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
isActivebooleanJa––

Antworten

  • 200 OK
GET /api/operator/guest-blocks

Operation: OperatorListBlockedGuests

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
POST /api/operator/guest-blocks

Operation: OperatorBlockGuest

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

BlockGuestRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
emailstringJaJa–
phonestringJaJa–
reasonstringJa––Why (required, at most 500 characters). Kept in the log for the window.

Antworten

  • 200 OK
GET /api/operator/guest-blocks/settings

Operation: OperatorGetGuestBlockSettings

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
PUT /api/operator/guest-blocks/settings

Operation: OperatorSaveGuestBlockSettings

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

SaveGuestBlockSettingsRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
enabledbooleanJa––
thresholdinteger (int32)Ja––
windowMonthsinteger (int32)Ja––

Antworten

  • 200 OK
POST /api/operator/guest-blocks/unblock

Operation: OperatorUnblockGuest

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

UnblockGuestRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
guestRefstringJaJa–
emailstringJaJa–
phonestringJaJa–
reasonstringJa––Why (required, at most 500 characters). Kept in the log for the window.

Antworten

  • 200 OK
POST /api/operator/legal/acceptances

Operation: OperatorAcceptLegalDocuments

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

AcceptLegalDocumentsRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
documentsarray of AcceptLegalDocumentDtoJa––
documents[].kindLegalDocumentKindJa–einer von: Terms, DataProcessingAgreementA legal document BookDinePlay publishes in numbered versions and every operator accepts at sign-up (and again when a newer version takes effect).
documents[].versionstringJa––
documents[].languagestringJa––

Antworten

  • 200 OK
GET /api/operator/me

Operation: OperatorMe

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
GET /api/operator/push/registration

Operation: OperatorPushRegistration

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK · application/json → PushRegistrationResponse
    PushRegistrationResponse
    FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
    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.
    appIdstringJaJa–The public OneSignal App ID the SDK initialises with.
    externalIdstringJaJa–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

Operation: OperatorTeam

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
POST /api/operator/team/invitations

Operation: OperatorInviteTeamMember

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

InviteTeamMemberRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
emailstringJa––
displayNamestringJa––
roleTeamRoleNein–einer von: Staff, Manager, OwnerManager or Staff (an Owner is never invited through the team).
employeeIdstring (uuid)NeinJa–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.
languagestringNeinJa–The invite mail's language, en or de; the account's language when omitted.

Antworten

  • 200 OK
DELETE /api/operator/team/{id}

Operation: OperatorRemoveTeamMember

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Antworten

  • 200 OK
PUT /api/operator/team/{id}/employee

Operation: OperatorLinkTeamMemberEmployee

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Anfrage-Body application/json

LinkTeamMemberEmployeeRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
employeeIdstring (uuid)JaJa–

Antworten

  • 200 OK
PUT /api/operator/team/{id}/role

Operation: OperatorChangeTeamMemberRole

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Anfrage-Body application/json

ChangeTeamMemberRoleRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
roleTeamRoleJa–einer von: Staff, Manager, OwnerWhat 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

CreateVenueRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
slugstringJa––
namestringJa––
taglinestringJa––
descriptionstringJa––
citystringJa––
countrystringJa––
timezonestringJa––
businessProfileBusinessProfileDtoJa––Venue business profile (address + contact), for the operator's edit surface.
businessProfile.legalNamestringJa––
businessProfile.addressLine1stringJa––
businessProfile.addressLine2stringJaJa–
businessProfile.citystringJa––
businessProfile.postalCodestringJa––
businessProfile.countrystringJa––
businessProfile.phonestringJa––
businessProfile.emailstringJa––
businessProfile.websitestringJaJa–
paymentPolicyPaymentPolicyDtoJa––Venue payment policy, for the operator's edit surface.
paymentPolicy.paymentsEnabledbooleanJa––
paymentPolicy.depositsEnabledbooleanJa––
paymentPolicy.currencystringJa––
paymentPolicy.defaultDepositAmountnumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
preferredLanguagestringNein–Standard en

Antworten

  • 200 OK
PUT /api/operator/venue

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

UpdateVenueRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
namestringJa––
taglinestringJa––
descriptionstringJa––
citystringJa––
countrystringJa––
timezonestringJa––
businessProfileBusinessProfileDtoJa––Venue business profile (address + contact), for the operator's edit surface.
businessProfile.legalNamestringJa––
businessProfile.addressLine1stringJa––
businessProfile.addressLine2stringJaJa–
businessProfile.citystringJa––
businessProfile.postalCodestringJa––
businessProfile.countrystringJa––
businessProfile.phonestringJa––
businessProfile.emailstringJa––
businessProfile.websitestringJaJa–
paymentPolicyPaymentPolicyDtoJa––Venue payment policy, for the operator's edit surface.
paymentPolicy.paymentsEnabledbooleanJa––
paymentPolicy.depositsEnabledbooleanJa––
paymentPolicy.currencystringJa––
paymentPolicy.defaultDepositAmountnumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
preferredLanguagestringNein–Standard en

Antworten

  • 200 OK
GET /api/operator/venue/allocation-settings

Operation: OperatorAllocationSettings

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
PUT /api/operator/venue/allocation-settings

Operation: OperatorUpdateAllocationSettings

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

UpdateAllocationSettingsRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
forecastEnabledbooleanNeinJa–
lookBackWeeksinteger (int32)NeinJa–
quietThresholdPercentinteger (int32)NeinJa–
maxSpareSeatsinteger (int32)NeinJa–
relaxedExtraSpareSeatsinteger (int32)NeinJa–
clearMaxSpareSeatsbooleanNein–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

CreateApiKeyRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
labelstringJa––
typeApiKeyTypeJa–einer von: Publishable, Secret, AppHow a key may be used, which decides both how it is stored and where it may be sent from.
allowedOriginsarray of stringJa––
deliveryApiKeyDeliveryNein–einer von: Inline, RevealHow 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

RevealApiKeyRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
ticketstringJa––

Antworten

  • 200 OK
DELETE /api/operator/venue/api-keys/{id}

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (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

Operation: OperatorAvailability

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
datequerystringJa––
partySizequeryinteger (int32)Nein–Standard 2
resourceTypequeryBookableResourceTypeNein–Standard RestaurantTable
einer von: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, Bar
durationMinutesqueryinteger (int32)Nein––
groupByquerystringNein––
resourceGroupquerystring (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

OperatorBookingDurationsDto
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
rulesarray of BookingDurationRuleDtoJa––
rules[].typeBookableResourceTypeJa–einer von: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, BarThe 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[].defaultMinutesinteger (int32)Ja––
rules[].minMinutesinteger (int32)Ja––
rules[].maxMinutesinteger (int32)Ja––
rules[].stepMinutesinteger (int32)Ja––
rules[].guestSelectablebooleanJa––

Antworten

  • 200 OK
GET /api/operator/venue/booking-rules

Operation: OperatorBookingRules

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
PUT /api/operator/venue/booking-rules

Operation: OperatorUpdateBookingRules

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

UpdateBookingRulesRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
rulesarray of UpdateBookingRuleDtoJa––
rules[].resourceTypeBookableResourceTypeJa–einer von: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, BarThe 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[].minimumNoticeMinutesinteger (int32)NeinJa–
rules[].bufferMinutesinteger (int32)NeinJa–
rules[].minPartySizeinteger (int32)NeinJa–
rules[].maxPartySizeinteger (int32)NeinJa–

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

ReservationCancellationPolicyDto
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
enabledbooleanJa––
hoursBeforeStartinteger (int32)Ja––
depositRefundReservationDepositRefundModeNein–einer von: NoOnlineRefund, RefundOnGuestCancel, ForfeitOnGuestCancelWhat 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

Operation: OperatorChildRules

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
PUT /api/operator/venue/child-rules

Operation: OperatorUpdateChildRules

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

SaveChildRulesRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
rulesarray of ChildRuleDtoJa––
rules[].resourceTypeBookableResourceTypeJa–einer von: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, BarThe 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[].maxChildrenPerSlotinteger (int32)NeinJa–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[].noChildrenFromstringNeinJa–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[].noChildrenUntilstringNeinJa–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

OperatorEventRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
titlestringJaJa–
slugstringJaJa–
excerptstringJaJa–
descriptionMarkdownstringJaJa–
imageUrlstringJaJa–
imageAltstringJaJa–
datestring (date)JaJa–
startstring (time)JaJa–
endstring (time)JaJa–
timeLabelstringJaJa–
locationLabelstringJaJa–
registrationOperatorEventRegistrationSettingsDtoJaJa–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.modeEventRegistrationModeJa–einer von: None, Free, PaidWhether guests can register for an event, and whether a ticket costs money.
registration.capacityinteger (int32)JaJa–
registration.maxTicketsPerRegistrationinteger (int32)JaJa–
registration.closesAtstring (date-time)JaJa–
registration.ticketPricenumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
registration.currencystringJaJa–
registration.refundPolicyModeRefundPolicyModeNein–einer von: NoOnlineRefund, FullRefundUntilHow a Paid event's tickets may be refunded online by the guest. See BookDinePlay.Domain.Events.EventRefundPolicy. Only meaningful for EventRegistrationMode.Paid events.
registration.refundHoursBeforeStartinteger (int32)Nein–Standard 0
registration.childTicketPricenumber (double)NeinJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
languagestringJaJa–

Antworten

  • 200 OK
POST /api/operator/venue/events/preview

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

OperatorEventPreviewRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
markdownstringJaJa–

Antworten

  • 200 OK
GET /api/operator/venue/events/{id}

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Antworten

  • 200 OK
PUT /api/operator/venue/events/{id}

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Anfrage-Body application/json

OperatorEventRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
titlestringJaJa–
slugstringJaJa–
excerptstringJaJa–
descriptionMarkdownstringJaJa–
imageUrlstringJaJa–
imageAltstringJaJa–
datestring (date)JaJa–
startstring (time)JaJa–
endstring (time)JaJa–
timeLabelstringJaJa–
locationLabelstringJaJa–
registrationOperatorEventRegistrationSettingsDtoJaJa–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.modeEventRegistrationModeJa–einer von: None, Free, PaidWhether guests can register for an event, and whether a ticket costs money.
registration.capacityinteger (int32)JaJa–
registration.maxTicketsPerRegistrationinteger (int32)JaJa–
registration.closesAtstring (date-time)JaJa–
registration.ticketPricenumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
registration.currencystringJaJa–
registration.refundPolicyModeRefundPolicyModeNein–einer von: NoOnlineRefund, FullRefundUntilHow a Paid event's tickets may be refunded online by the guest. See BookDinePlay.Domain.Events.EventRefundPolicy. Only meaningful for EventRegistrationMode.Paid events.
registration.refundHoursBeforeStartinteger (int32)Nein–Standard 0
registration.childTicketPricenumber (double)NeinJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
languagestringJaJa–

Antworten

  • 200 OK
DELETE /api/operator/venue/events/{id}

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Antworten

  • 200 OK
POST /api/operator/venue/events/{id}/cancel

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Antworten

  • 200 OK
POST /api/operator/venue/events/{id}/check-in

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Anfrage-Body application/json

OperatorEventCheckInRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
codestringJaJa–

Antworten

  • 200 OK
POST /api/operator/venue/events/{id}/publish

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Antworten

  • 200 OK
GET /api/operator/venue/events/{id}/registrations

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––
pagequeryinteger (int32)Nein––
pageSizequeryinteger (int32)Nein––
statusquerystringNein––

Antworten

  • 200 OK
GET /api/operator/venue/events/{id}/registrations.csv

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Antworten

  • 200 OK
GET /api/operator/venue/events/{id}/registrations/{registrationId}

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––
registrationIdpathstring (uuid)Ja––

Antworten

  • 200 OK
POST /api/operator/venue/events/{id}/registrations/{registrationId}/cancel

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––
registrationIdpathstring (uuid)Ja––

Antworten

  • 200 OK
POST /api/operator/venue/events/{id}/registrations/{registrationId}/refund

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––
registrationIdpathstring (uuid)Ja––

Antworten

  • 200 OK
POST /api/operator/venue/events/{id}/tickets/{code}/undo-check-in

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––
codepathstringJa––

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

SaveExtrasRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
extrasarray of SaveExtraDtoJa––
extras[].idstringJaJa–
extras[].namestringJa––
extras[].descriptionstringJa––
extras[].pricenumber (double)Ja–Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
extras[].basisExtraPricingBasisJa–einer von: PerPerson, PerBookingHow an extra is charged.
extras[].appliesToarray of BookableResourceTypeJa–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

SaveFloorPlanRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
placementsarray of PlacementDtoJa––
placements[].codestringJa––
placements[].zoneIdstring (uuid)JaJa–
placements[].xnumber (double)Ja–Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$
placements[].ynumber (double)Ja–Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$
placements[].widthnumber (double)Ja–Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$
placements[].heightnumber (double)Ja–Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$
placements[].shapestringJa––
placements[].rotationinteger (int32)Ja––

Antworten

  • 200 OK
GET /api/operator/venue/high-chairs

Operation: OperatorHighChairs

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
PUT /api/operator/venue/high-chairs

Operation: OperatorUpdateHighChairs

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

SaveHighlightRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
statusHighlightStatusJa–einer von: Draft, PublishedDraft or published.
titlestringJa––The headline.
textstringJaJa–Optional short text.
imageUrlstringJaJa–The card's image (required); an upload through POST /api/operator/venue/menus/media returns one.
linkKindHighlightLinkKindJa–einer von: None, MenuItem, Event, VoucherProduct, ExternalWhat the card links to.
linkTargetstringJaJa–Required for every kind but None; refused with None.
sortOrderinteger (int32)Ja––Manual order among highlights (0 to 999).
visibleFromstring (date)JaJa–First venue-local day the card shows; null means no lower bound.
visibleTostring (date)JaJa–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

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Antworten

  • 200 OK
PUT /api/operator/venue/highlights/{id}

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Anfrage-Body application/json

SaveHighlightRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
statusHighlightStatusJa–einer von: Draft, PublishedDraft or published.
titlestringJa––The headline.
textstringJaJa–Optional short text.
imageUrlstringJaJa–The card's image (required); an upload through POST /api/operator/venue/menus/media returns one.
linkKindHighlightLinkKindJa–einer von: None, MenuItem, Event, VoucherProduct, ExternalWhat the card links to.
linkTargetstringJaJa–Required for every kind but None; refused with None.
sortOrderinteger (int32)Ja––Manual order among highlights (0 to 999).
visibleFromstring (date)JaJa–First venue-local day the card shows; null means no lower bound.
visibleTostring (date)JaJa–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

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (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

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstringJa––

Antworten

  • 200 OK
GET /api/operator/venue/menus

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
PUT /api/operator/venue/menus

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

SaveMenusRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
menusarray of SaveMenuDtoJa––
menus[].idstringJaJa–
menus[].namestringJa––
menus[].descriptionstringJa––
menus[].kindMenuKindJa–einer von: Food, DrinksWhether a menu serves food or drinks. Whether a resource may order food is a per-resource setting (BookableResource.AllowsFoodOrdering in BookDinePlay.Domain), defaulted by resource type via MenuAvailability.DefaultAllowsFoodOrdering and overridable by the venue operator. Those are named rather than cross-referenced because this assembly does not reference Domain.
menus[].groupsarray of SaveMenuGroupDtoJa––
menus[].groups[].namestringJa––
menus[].groups[].descriptionstringJaJa–
menus[].groups[].itemsarray of SaveMenuItemDtoJa––
menus[].groups[].items[].namestringJa––
menus[].groups[].items[].descriptionstringJa––
menus[].groups[].items[].pricenumber (double)Ja–Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
menus[].groups[].items[].taxRatenumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
menus[].groups[].items[].tagsarray of stringJa––
menus[].groups[].items[].imageUrlstringJaJa–
menus[].groups[].items[].idstringNeinJa–

Antworten

  • 200 OK
POST /api/operator/venue/menus/media

Braucht ein Auth0-Bearer-Token.

Anfrage-Body multipart/form-data

string (binary)

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

NameOrtTypPflichtNull erlaubtEinschränkungen
threadIdpathstring (uuid)Ja––

Anfrage-Body application/json

OperatorReplyRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
bodystringJa––

Antworten

  • 200 OK
GET /api/operator/venue/notification-preferences

Operation: OperatorMyNotificationPreferences

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
PUT /api/operator/venue/notification-preferences

Operation: OperatorSaveMyNotificationPreferences

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

SaveStaffNotificationPreferencesRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
newBookingsbooleanJa––
bookingRequestsbooleanJa––
cancellationsbooleanJa––
guestMessagesbooleanJa––
allOrdersbooleanJa––
orderStationIdsarray 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

OperatorOpeningHoursDto
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
regulararray of OperatorDayHoursDtoJa––
regular[].daystringJa––
regular[].isClosedbooleanJa––
regular[].opensstringJaJa–
regular[].closesstringJaJa–
regular[].breaksarray of HoursBreakDtoJa––
regular[].breaks[].startstringJa––
regular[].breaks[].endstringJa––
specialarray of OperatorSpecialHoursDtoJa––
special[].datestringJa––
special[].isClosedbooleanJa––
special[].opensstringJaJa–
special[].closesstringJaJa–
special[].notestringJaJa–
special[].breaksarray of HoursBreakDtoJa––
special[].breaks[].startstringJa––
special[].breaks[].endstringJa––

Antworten

  • 200 OK
GET /api/operator/venue/orders

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
GET /api/operator/venue/payouts

Operation: GetPayoutStatus

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
POST /api/operator/venue/payouts/onboarding-link

Operation: StartPayoutOnboarding

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
POST /api/operator/venue/payouts/refresh

Operation: RefreshPayoutStatus

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

NameOrtTypPflichtNull erlaubtEinschränkungen
codepathstringJa––

Antworten

  • 200 OK
POST /api/operator/venue/qr-codes/{code}/regenerate

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
codepathstringJa––

Antworten

  • 200 OK
GET /api/operator/venue/request-settings

Operation: OperatorRequestSettings

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
PUT /api/operator/venue/request-settings

Operation: OperatorUpdateRequestSettings

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

ReservationRequestSettingsDto
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
groupRequestThresholdinteger (int32)NeinJa–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.
holdMinutesinteger (int32)Nein–Standard 1440How long an unanswered request keeps its tables before it expires, in whole quarter hours from 30 minutes to 7 days. Default 1440 (24 hours).
childrenSlotsarray of HighValueSlotDtoNeinJa–The windows in which a booking with children is a request; empty switches the rule off. At most 20.
childrenSlots[].namestringJaJa–A label for the console ("Friday and Saturday evening"); at most 80 characters.
childrenSlots[].daysarray of DayOfWeekJa–einer von: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, SaturdayThe weekdays it applies to; at least one, no repeats.
childrenSlots[].fromstringJa––First start time that is inside the window, HH:mm venue-local.
childrenSlots[].tostringJa––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[].validFromstringNeinJa–First date the window is in force, yyyy-MM-dd, inclusive; null = from the start.
childrenSlots[].validTostringNeinJa–Last date it is in force, inclusive; null = without end.

Antworten

  • 200 OK
GET /api/operator/venue/requests

Operation: OperatorReservationRequests

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
POST /api/operator/venue/requests/{reference}/approve

Operation: OperatorApproveReservationRequest

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
referencepathstringJa––

Anfrage-Body application/json

ApproveReservationRequestRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
depositAmountnumber (double)NeinJaMuster ^-?(?: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

Operation: OperatorDeclineReservationRequest

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
referencepathstringJa––

Anfrage-Body application/json

DeclineReservationRequestRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
messagestringNeinJa–An optional note to the guest, at most 500 characters, quoted in the decline e-mail.

Antworten

  • 200 OK
GET /api/operator/venue/reservations

Operation: OperatorReservations

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
datequerystringJa––

Antworten

  • 200 OK
POST /api/operator/venue/reservations

Operation: OperatorCreateReservation

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

CreateOperatorReservationRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
resourceTypeBookableResourceTypeJa–einer von: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, BarThe 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.
resourceIdstringNeinJa–Optional specific resource id. When omitted the service picks the first available resource of the type.
datestringJa––Venue-local date, "yyyy-MM-dd".
startstringJa––Venue-local start time, "HH:mm".
endstringNeinJa–Optional venue-local end time, "HH:mm". Defaults to the resource slot length.
partySizeinteger (int32)Ja–min. 1
max. 200
gamesinteger (int32)NeinJamin. 1
max. 10
How many games to book, for resources priced per game. Defaults to 1 when omitted.
customerNamestringJa–Länge 2–120
emailstringNeinJamax. 256 ZeichenOptional 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).
phonestringNeinJaLänge 3–40Optional. 3–40 characters when supplied; blank is treated as not supplied.
notesstringNeinJamax. 500 Zeichen
extrasarray of ExtraSelectionDtoNeinJa–Optional extras to add to the booking, e.g. shoe rental.
extras[].extraIdstringJa––
extras[].quantityinteger (int32)Ja–min. 1
max. 100
durationMinutesinteger (int32)NeinJamin. 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.
languagestringNeinJa–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.
childreninteger (int32)NeinJamin. 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.
highChairsinteger (int32)NeinJamin. 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}

Operation: OperatorGetReservation

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
referencepathstringJa––

Antworten

  • 200 OK
PUT /api/operator/venue/reservations/{reference}

Operation: OperatorUpdateReservation

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
referencepathstringJa––

Anfrage-Body application/json

UpdateOperatorReservationRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
resourceTypeBookableResourceTypeJa–einer von: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, BarThe 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.
resourceIdstringNeinJa–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.
datestringJa––Venue-local date, "yyyy-MM-dd".
startstringJa––Venue-local start time, "HH:mm".
endstringNeinJa–
partySizeinteger (int32)Ja–min. 1
max. 200
gamesinteger (int32)NeinJamin. 1
max. 10
customerNamestringJa–Länge 2–120
emailstringNeinJamax. 256 ZeichenOptional; at least one of string? UpdateOperatorReservationRequest.Email or string? UpdateOperatorReservationRequest.Phone is required — see IEnumerable<ValidationResult> UpdateOperatorReservationRequest.Validate(ValidationContext validationContext).
phonestringNeinJaLänge 3–40
notesstringNeinJamax. 500 Zeichen
extrasarray of ExtraSelectionDtoNeinJa–
extras[].extraIdstringJa––
extras[].quantityinteger (int32)Ja–min. 1
max. 100
durationMinutesinteger (int32)NeinJamin. 15
max. 1440
childreninteger (int32)NeinJamin. 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.
highChairsinteger (int32)NeinJamin. 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

Operation: OperatorAssignReservationTable

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
referencepathstringJa––

Anfrage-Body application/json

AssignReservationTableRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
resourceIdstringJa––The id of the restaurant table to seat the booking at.

Antworten

  • 200 OK
POST /api/operator/venue/reservations/{reference}/refund

Operation: OperatorRefundReservationDeposit

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
referencepathstringJa––

Antworten

  • 200 OK
POST /api/operator/venue/reservations/{reference}/status

Operation: OperatorSetReservationStatus

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
referencepathstringJa––

Anfrage-Body application/json

SetReservationStatusRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
statusReservationStatusJa–einer von: Pending, Confirmed, Cancelled, Completed, NoShow, PaidButUnavailableLifecycle 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

SaveResourceBlockRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
resourceIdstringNeinJa–Code of the resource to block (required on create).
fromstringNeinJa–First blocked date ("yyyy-MM-dd"), or null for no start bound.
tostringNeinJa–Last blocked date ("yyyy-MM-dd"), or null for no end bound.
daysarray of DayOfWeekNeinJaeiner von: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, SaturdayWeekdays; null or empty means every day.
startTimestringNeinJa–Start of the daily window ("HH:mm"); give both times or neither.
endTimestringNeinJa–End of the daily window ("HH:mm"); at or before the start it runs past midnight.
seatsinteger (int32)NeinJa–Seats to block on a seat-sold resource; null blocks the whole resource.
notestringNeinJa–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

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Anfrage-Body application/json

SaveResourceBlockRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
resourceIdstringNeinJa–Code of the resource to block (required on create).
fromstringNeinJa–First blocked date ("yyyy-MM-dd"), or null for no start bound.
tostringNeinJa–Last blocked date ("yyyy-MM-dd"), or null for no end bound.
daysarray of DayOfWeekNeinJaeiner von: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, SaturdayWeekdays; null or empty means every day.
startTimestringNeinJa–Start of the daily window ("HH:mm"); give both times or neither.
endTimestringNeinJa–End of the daily window ("HH:mm"); at or before the start it runs past midnight.
seatsinteger (int32)NeinJa–Seats to block on a seat-sold resource; null blocks the whole resource.
notestringNeinJa–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

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (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

SaveResourceGroupRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
namestringJa––
descriptionstringJa––

Antworten

  • 200 OK
PUT /api/operator/venue/resource-groups/{id}

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Anfrage-Body application/json

UpdateResourceGroupRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
namestringJa––
descriptionstringJa––
ordinalinteger (int32)Ja––

Antworten

  • 200 OK
DELETE /api/operator/venue/resource-groups/{id}

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (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

SaveResourceRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
namestringJa––
typeBookableResourceTypeJa–einer von: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, BarThe 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.
capacityinteger (int32)Ja––
descriptionstringJa––
slotDurationMinutesinteger (int32)JaJa–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.
pricingResourcePricingDtoJa––Pricing details for a bookable resource.
pricing.modelPricingModelJa–einer von: Free, PerHour, PerGame, PerSession, FixedFee, Deposit, MinimumSpendHow a bookable resource is priced.
pricing.amountnumber (double)Ja–Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
pricing.currencystringJa––
pricing.depositAmountnumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
pricing.minimumSpendnumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
pricing.unitLabelstringJa––
pricing.childAmountnumber (double)NeinJaMuster ^-?(?: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.depositPerPersonbooleanNein–Standard falseWhether DepositAmount is charged per person instead of once per booking (#556). False for every pre-existing resource and payload.
pricing.childDepositAmountnumber (double)NeinJaMuster ^-?(?: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.
allowsFoodOrderingbooleanJaJa–
seatSoldbooleanNeinJa–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

NameOrtTypPflichtNull erlaubtEinschränkungen
codepathstringJa––

Anfrage-Body application/json

SaveResourceRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
namestringJa––
typeBookableResourceTypeJa–einer von: RestaurantTable, BilliardTable, DartBoard, Shuffleboard, BowlingLane, EventArea, Other, BarThe 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.
capacityinteger (int32)Ja––
descriptionstringJa––
slotDurationMinutesinteger (int32)JaJa–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.
pricingResourcePricingDtoJa––Pricing details for a bookable resource.
pricing.modelPricingModelJa–einer von: Free, PerHour, PerGame, PerSession, FixedFee, Deposit, MinimumSpendHow a bookable resource is priced.
pricing.amountnumber (double)Ja–Muster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
pricing.currencystringJa––
pricing.depositAmountnumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
pricing.minimumSpendnumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
pricing.unitLabelstringJa––
pricing.childAmountnumber (double)NeinJaMuster ^-?(?: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.depositPerPersonbooleanNein–Standard falseWhether DepositAmount is charged per person instead of once per booking (#556). False for every pre-existing resource and payload.
pricing.childDepositAmountnumber (double)NeinJaMuster ^-?(?: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.
allowsFoodOrderingbooleanJaJa–
seatSoldbooleanNeinJa–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

NameOrtTypPflichtNull erlaubtEinschränkungen
codepathstringJa––

Antworten

  • 200 OK
PUT /api/operator/venue/resources/{code}/group

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
codepathstringJa––

Anfrage-Body application/json

AssignResourceGroupRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
resourceGroupIdstring (uuid)JaJa–

Antworten

  • 200 OK
GET /api/operator/venue/shifts

Operation: OperatorShifts

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
fromquerystring (date)Nein––
toquerystring (date)Nein––
memberIdquerystring (uuid)Nein––

Antworten

  • 200 OK
POST /api/operator/venue/shifts

Operation: OperatorCreateShift

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

SaveStaffShiftRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
memberIdstring (uuid)Ja––
datestring (date)Ja––
startTimestring (time)Ja––
endTimestring (time)Ja––
notestringNeinJa–

Antworten

  • 200 OK
GET /api/operator/venue/shifts/mine

Operation: OperatorMyShifts

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
PUT /api/operator/venue/shifts/{id}

Operation: OperatorUpdateShift

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Anfrage-Body application/json

SaveStaffShiftRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
memberIdstring (uuid)Ja––
datestring (date)Ja––
startTimestring (time)Ja––
endTimestring (time)Ja––
notestringNeinJa–

Antworten

  • 200 OK
DELETE /api/operator/venue/shifts/{id}

Operation: OperatorDeleteShift

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Antworten

  • 200 OK
GET /api/operator/venue/specials

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
archivedquerybooleanNein–Standard false

Antworten

  • 200 OK
POST /api/operator/venue/specials

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

SaveSpecialRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
kindSpecialKindJa–einer von: Dish, MenuItemDish or a discount on a menu item.
statusSpecialStatusJa–einer von: Draft, Published, ArchivedDraft, live or archived.
titlestringJa––The headline.
descriptionstringJaJa–Optional description.
imageUrlstringJaJa–The special's own image.
pricenumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Required for a Dish (400 PriceRequired); on a menu-item special null means the item's own price.
taxRatenumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$The tax rate; null means none recorded (a menu-item special inherits the item's).
menuItemIdstringJaJa–The referenced menu item's id, if any.
sortOrderinteger (int32)Ja––Manual order among specials.
startsOnstring (date)JaJa–First day it runs; null means no lower bound.
endsOnstring (date)JaJa–Last day it runs; null means no upper bound.
weekdaysarray of DayOfWeekJaJaeiner von: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, SaturdayDays of the week it runs on; null or empty means every day.
windowStartstring (time)JaJa–Start of the daily window; null means all day. One side alone is refused.
windowEndstring (time)JaJa–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

NameOrtTypPflichtNull erlaubtEinschränkungen
datequerystringNein––
daysquerystringNein––

Antworten

  • 200 OK
POST /api/operator/venue/specials/preview

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

SpecialsPreviewRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
datestring (date)Ja––The day to preview.
draftSaveSpecialRequestNeinJa–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.kindSpecialKindJa–einer von: Dish, MenuItemDish or a discount on a menu item.
draft.statusSpecialStatusJa–einer von: Draft, Published, ArchivedDraft, live or archived.
draft.titlestringJa––The headline.
draft.descriptionstringJaJa–Optional description.
draft.imageUrlstringJaJa–The special's own image.
draft.pricenumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Required for a Dish (400 PriceRequired); on a menu-item special null means the item's own price.
draft.taxRatenumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$The tax rate; null means none recorded (a menu-item special inherits the item's).
draft.menuItemIdstringJaJa–The referenced menu item's id, if any.
draft.sortOrderinteger (int32)Ja––Manual order among specials.
draft.startsOnstring (date)JaJa–First day it runs; null means no lower bound.
draft.endsOnstring (date)JaJa–Last day it runs; null means no upper bound.
draft.weekdaysarray of DayOfWeekJaJaeiner von: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, SaturdayDays of the week it runs on; null or empty means every day.
draft.windowStartstring (time)JaJa–Start of the daily window; null means all day. One side alone is refused.
draft.windowEndstring (time)JaJa–End of the daily window; null means all day. One side alone is refused.
draftIdstring (uuid)NeinJa–The id of a stored special the draft replaces.

Antworten

  • 200 OK
GET /api/operator/venue/specials/print

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
datequerystringNein––
daysquerystringNein––
paperquerystringNein––
langquerystringNein––

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

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Antworten

  • 200 OK
PUT /api/operator/venue/specials/{id}

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Anfrage-Body application/json

SaveSpecialRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
kindSpecialKindJa–einer von: Dish, MenuItemDish or a discount on a menu item.
statusSpecialStatusJa–einer von: Draft, Published, ArchivedDraft, live or archived.
titlestringJa––The headline.
descriptionstringJaJa–Optional description.
imageUrlstringJaJa–The special's own image.
pricenumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Required for a Dish (400 PriceRequired); on a menu-item special null means the item's own price.
taxRatenumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$The tax rate; null means none recorded (a menu-item special inherits the item's).
menuItemIdstringJaJa–The referenced menu item's id, if any.
sortOrderinteger (int32)Ja––Manual order among specials.
startsOnstring (date)JaJa–First day it runs; null means no lower bound.
endsOnstring (date)JaJa–Last day it runs; null means no upper bound.
weekdaysarray of DayOfWeekJaJaeiner von: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, SaturdayDays of the week it runs on; null or empty means every day.
windowStartstring (time)JaJa–Start of the daily window; null means all day. One side alone is refused.
windowEndstring (time)JaJa–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

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Antworten

  • 200 OK
GET /api/operator/venue/staff-access-grants

Operation: OperatorStaffAccessGrants

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
memberIdquerystring (uuid)Nein––

Antworten

  • 200 OK
POST /api/operator/venue/staff-access-grants

Operation: OperatorGrantStaffAccess

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

GrantStaffAccessRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
memberIdstring (uuid)Ja––
minutesinteger (int32)Ja––
reasonstringNeinJa–

Antworten

  • 200 OK
DELETE /api/operator/venue/staff-access-grants/{id}

Operation: OperatorRevokeStaffAccess

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Antworten

  • 200 OK
GET /api/operator/venue/staff-access-policy

Operation: OperatorStaffAccessPolicy

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
PUT /api/operator/venue/staff-access-policy

Operation: OperatorSaveStaffAccessPolicy

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

SaveStaffAccessPolicyRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
bufferBeforeMinutesinteger (int32)Ja––
bufferAfterMinutesinteger (int32)Ja––

Antworten

  • 200 OK
PUT /api/operator/venue/station-routes

Operation: OperatorSaveStationRoutes

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

SaveStationRoutesRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
routesarray of StationRouteDtoJa––
routes[].stationIdstring (uuid)Ja––
routes[].menuIdstringJa––
routes[].groupNamestringNeinJa–
routes[].menuItemIdstringNeinJa–

Antworten

  • 200 OK
GET /api/operator/venue/stations

Operation: OperatorStations

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
POST /api/operator/venue/stations

Operation: OperatorCreateStation

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

SaveVenueStationRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
namestringJa––1 to 40 characters, unique at the venue (case-insensitive).
sortOrderinteger (int32)Nein–Standard 0Where the station is listed; lower first.

Antworten

  • 200 OK
PUT /api/operator/venue/stations/{id}

Operation: OperatorUpdateStation

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Anfrage-Body application/json

SaveVenueStationRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
namestringJa––1 to 40 characters, unique at the venue (case-insensitive).
sortOrderinteger (int32)Nein–Standard 0Where the station is listed; lower first.

Antworten

  • 200 OK
DELETE /api/operator/venue/stations/{id}

Operation: OperatorDeleteStation

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (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

SaveTableMergeOptionRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
namestringJa––
resourceCodesarray of stringJa––
capacityinteger (int32)Ja––

Antworten

  • 200 OK
PUT /api/operator/venue/table-merges/{id}

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Anfrage-Body application/json

SaveTableMergeOptionRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
namestringJa––
resourceCodesarray of stringJa––
capacityinteger (int32)Ja––

Antworten

  • 200 OK
DELETE /api/operator/venue/table-merges/{id}

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Antworten

  • 200 OK
GET /api/operator/venue/team/{memberId}/notification-preferences

Operation: OperatorMemberNotificationPreferences

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
memberIdpathstring (uuid)Ja––

Antworten

  • 200 OK
PUT /api/operator/venue/team/{memberId}/notification-preferences

Operation: OperatorSaveMemberNotificationPreferences

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
memberIdpathstring (uuid)Ja––

Anfrage-Body application/json

SaveStaffNotificationPreferencesRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
newBookingsbooleanJa––
bookingRequestsbooleanJa––
cancellationsbooleanJa––
guestMessagesbooleanJa––
allOrdersbooleanJa––
orderStationIdsarray 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

SaveVoucherSettingsRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
onlineSaleEnabledbooleanJa––
validityVoucherValidityDtoJaJa–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.modeVoucherValidityModeJa–einer von: Months, FixedDate, YearEndAfterYearsHow a venue's voucher validity rule computes an expiry date from the issue date.
validity.monthsinteger (int32)JaJa–
validity.fixedDatestringJaJa–
validity.yearsinteger (int32)JaJa–
productsarray of VoucherProductDtoJa––
products[].idstringJaJa–Null for a new product, which the server mints an id for; a known id is preserved.
products[].kindVoucherKindJa–einer von: Amount, Percentage, ItemWhat a voucher is worth, and so how it redeems.
products[].titleEnstringJa––
products[].titleDestringJaJa–
products[].vatClassificationVoucherVatClassificationJaJaeiner von: SinglePurpose, MultiPurpose
products[].amountnumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$VoucherKind.Amount with a fixed value: the value and the sale price.
products[].customAmountbooleanJa––VoucherKind.Amount: the buyer picks the value within MinAmount–MaxAmount.
products[].minAmountnumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
products[].maxAmountnumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
products[].percentagenumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
products[].maxDiscountnumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
products[].menuItemIdstringJaJa–VoucherKind.Item: the menu item's stable id; it must exist in the venue's menus.
products[].menuItemNamestringJaJa–Ignored on save: the server snapshots the menu item's current name.
products[].salePricenumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$The online sale price of a percentage or item product; required when it is sold online.
products[].sellOnlinebooleanJa––
products[].activebooleanJa––
products[].sortOrderinteger (int32)Ja––
termsEnstringJaJa–
termsDestringJaJa–

Antworten

  • 200 OK
GET /api/operator/venue/vouchers

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
searchquerystringNein––
statusquerystringNein––
pagequeryinteger (int32)Nein––
pageSizequeryinteger (int32)Nein––

Antworten

  • 200 OK
POST /api/operator/venue/vouchers

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

IssueVoucherRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
productIdstringJaJa–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.
kindVoucherKindJaJaeiner von: Amount, Percentage, ItemWhat a voucher is worth, and so how it redeems.
amountnumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Ad hoc VoucherKind.Amount, or the value of a custom-amount product.
percentagenumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
maxDiscountnumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
menuItemIdstringJaJa–Ad hoc VoucherKind.Item: the menu item's stable id.
vatClassificationVoucherVatClassificationJaJaeiner von: SinglePurpose, MultiPurpose
paymentVoucherManualPaymentJa–einer von: Cash, CardAtTill, NotPaidHow the voucher was paid at the venue; VoucherManualPayment.NotPaid for a promo or goodwill voucher.
pricePaidnumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$What was taken at the till; required unless Payment is VoucherManualPayment.NotPaid.
expiresOnstringJaJa–Overrides the venue's validity rule (yyyy-MM-dd). A paid voucher must be valid for at least one year.
recipientNamestringJaJa–
recipientEmailstringJaJa–
giftMessagestringJaJa–
languagestringJaJa–"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

VoucherLookupRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
codestringJa––

Antworten

  • 200 OK
GET /api/operator/venue/vouchers/{id}

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Antworten

  • 200 OK
PUT /api/operator/venue/vouchers/{id}/expiry

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Anfrage-Body application/json

ChangeVoucherExpiryRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
expiresOnstringJa––
reasonstringJa––

Antworten

  • 200 OK
GET /api/operator/venue/vouchers/{id}/printable

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Antworten

  • 200 OK
POST /api/operator/venue/vouchers/{id}/redemptions

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Anfrage-Body application/json

RedeemVoucherRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
amountnumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
billTotalnumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
tabSessionIdstring (uuid)JaJa–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.
tabLineIndexinteger (int32)JaJa–Item vouchers on a tab: the zero-based index into the tab's lines (IReadOnlyList<TabLineDto>? TableTabDto.Lines / IReadOnlyList<TabLineDto> TableSessionResponse.Tab).
billReferencestringJaJa–Optional free text from staff (at most 80 characters), e.g. the till receipt number.
tabLineItemNamestringNeinJa–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

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––
transactionIdpathstring (uuid)Ja––

Anfrage-Body application/json

ReverseVoucherRedemptionRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
reasonstringJaJa–

Antworten

  • 200 OK
POST /api/operator/venue/vouchers/{id}/refund

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Antworten

  • 200 OK
POST /api/operator/venue/vouchers/{id}/resend

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Antworten

  • 200 OK
POST /api/operator/venue/vouchers/{id}/void

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Anfrage-Body application/json

VoidVoucherRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
reasonstringJa––

Antworten

  • 200 OK
POST /api/operator/venue/zones

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

SaveZoneRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
namestringJa––

Antworten

  • 200 OK
PUT /api/operator/venue/zones/{id}

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Anfrage-Body application/json

UpdateZoneRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
namestringJa––
ordinalinteger (int32)Ja––

Antworten

  • 200 OK
DELETE /api/operator/venue/zones/{id}

Braucht ein Auth0-Bearer-Token.

Parameter

NameOrtTypPflichtNull erlaubtEinschränkungen
idpathstring (uuid)Ja––

Antworten

  • 200 OK
GET /api/operator/venues

Operation: OperatorVenues

Braucht ein Auth0-Bearer-Token.

Antworten

  • 200 OK
POST /api/operator/venues

Braucht ein Auth0-Bearer-Token.

Anfrage-Body application/json

CreateVenueRequest
FeldTypPflichtNull erlaubtEinschränkungenBeschreibung
slugstringJa––
namestringJa––
taglinestringJa––
descriptionstringJa––
citystringJa––
countrystringJa––
timezonestringJa––
businessProfileBusinessProfileDtoJa––Venue business profile (address + contact), for the operator's edit surface.
businessProfile.legalNamestringJa––
businessProfile.addressLine1stringJa––
businessProfile.addressLine2stringJaJa–
businessProfile.citystringJa––
businessProfile.postalCodestringJa––
businessProfile.countrystringJa––
businessProfile.phonestringJa––
businessProfile.emailstringJa––
businessProfile.websitestringJaJa–
paymentPolicyPaymentPolicyDtoJa––Venue payment policy, for the operator's edit surface.
paymentPolicy.paymentsEnabledbooleanJa––
paymentPolicy.depositsEnabledbooleanJa––
paymentPolicy.currencystringJa––
paymentPolicy.defaultDepositAmountnumber (double)JaJaMuster ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
preferredLanguagestringNein–Standard en

Antworten

  • 200 OK

Problemtypen

Jeder Problem-type der Form https://bookdineplay.com/docs/api/errors/<reason> landet im gleichnamigen Abschnitt der Fehlerseite.