# GET /v2/booking/list/data Vollständige Buchungsübersicht lesen Liest den gespeicherten Buchungsstand mit Teilnehmerpositionen, Preisen, Zusatzleistungen, Antworten, Zahlungen, Rechnungsadresse, Rechts- und Stornierungsinformationen. Genau eine bestehende Buchung wird über die Pfad-ID oder den ersten filter-Eintrag mit property=id ausgewählt; dies ist keine Listenabfrage. - Operation-ID: get_v2_booking_list_data - Dokumentation: /docs/api/v2/operations/get-v2-booking-list-data-58949bf0c846/ - OpenAPI-Version: 3.2.1 - Vollständige Spezifikation: /docs/api/v2/openapi.json - Dokumentationsstatus: reviewed - Ändert Zustand: nein, gemäss Annotation - Für Automation freigegeben: nein ## Server Serverwerte stammen unverändert aus der Datei. Eine lokale Entwicklungsadresse ist keine bestätigte Produktionsadresse. `API_ORIGIN` muss auf die passende Instanz gesetzt werden. ```json [ { "url": "https://app2.edoobox.com", "description": "edoobox API" } ] ``` ## Authentifizierung Eine der folgenden Alternativen genügt (ODER). Innerhalb einer Alternative müssen alle Verfahren gemeinsam erfüllt sein (UND). 1. **bearerAuth** (HTTP bearer) — Existing edoobox v2 access token. Never substitute API key/secret headers. **UND** **accountContext** (header: edid) — Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account. 2. **sessionCookie** (cookie: _edlogin) — Existing browser login session, with the same permission checks as Bearer authentication. **UND** **accountContext** (header: edid) — Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account. ### Wirksame Security Requirements und vollständige Verfahren ```json { "security": [ { "bearerAuth": [], "accountContext": [] }, { "sessionCookie": [], "accountContext": [] } ], "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Existing edoobox v2 access token. Never substitute API key/secret headers." }, "accountContext": { "type": "apiKey", "in": "header", "name": "edid", "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account." }, "sessionCookie": { "type": "apiKey", "in": "cookie", "name": "_edlogin", "description": "Existing browser login session, with the same permission checks as Bearer authentication." } } } ``` ## Parameter | Name | Ort | Pflicht | Beschreibung | | --- | --- | --- | --- | | filter | query | ja | Die erste Filterposition muss die konkrete Buchungs-ID enthalten. | | language | header | nein | Account language code, where the resource supports setLanguage(). | | X-Edoobox-If-Revision | header | nein | Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review. | ### Vollständige wirksame Parameterdefinitionen ```json [ { "name": "filter", "in": "query", "required": true, "description": "Die erste Filterposition muss die konkrete Buchungs-ID enthalten.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "expression": { "type": "string" }, "value": {} }, "additionalProperties": true, "required": [ "property", "value" ] }, "allOf": [ { "contains": { "type": "object", "properties": { "property": { "const": "id" }, "value": { "type": "string", "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "booking_012345abcdef_123456" ], "description": "Öffentliche v2-ID aus dem ausgewählten Konto." } }, "additionalProperties": true, "required": [ "property", "value" ] } } ], "prefixItems": [ { "type": "object", "properties": { "property": { "const": "id" }, "value": { "type": "string", "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "booking_012345abcdef_123456" ], "description": "Öffentliche v2-ID aus dem ausgewählten Konto." } }, "additionalProperties": true, "required": [ "property", "value" ] } ], "minItems": 1 }, "example": [ { "property": "id", "value": "booking_012345abcdef_123456" } ] } } }, { "name": "language", "in": "header", "required": false, "description": "Account language code, where the resource supports setLanguage().", "schema": { "type": "string", "examples": [ "de" ] } }, { "name": "X-Edoobox-If-Revision", "in": "header", "required": false, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "examples": [ "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" ] }, "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review." } ] ``` ## Anfrage Kein Request Body deklariert. ## Antworten HTTP-Status und Antwortinhalt gemeinsam auswerten. Die folgenden Beschreibungen und Schemata sind die Angaben der Quelldatei. ```json { "200": { "description": "Erweiterte fachliche Rückgabe in data; die aufgeführten Sammlungen können leer sein und enthalten ausschliesslich öffentliche Referenzen.", "content": { "application/json": { "example": { "success": true, "error": false, "data": { "transactions": [ { "id": "transaction_012345abcdef_123456", "number": "2026-1001", "amount": 120, "currency": "CHF" } ], "users": [ { "active": true, "participant": "participant_012345abcdef_123456", "position": "person", "user": "user_012345abcdef_123456", "pricecategory": "pricecategory_012345abcdef_123456", "cert_visible": false } ], "payments": [], "promotion": false, "multi_offer": false, "dates": [], "lessons_booking": false, "invoice_address": { "active": false, "b2b": false, "data0": "", "data1": "", "data2": "", "data3": "", "data4": "", "data5": "", "data7": "", "data8": "" }, "label": false, "ip_address": "192.0.2.1", "offer": "offer_012345abcdef_123456", "questiongroup": [], "multi_offer_questiongroup": [], "deliverables": [], "pricecategory": { "pricecategory_012345abcdef_123456": { "id": "pricecategory_012345abcdef_123456", "count": 1, "name": "Standard", "amount": 120, "default": true, "offer": "offer_012345abcdef_123456" } }, "legaltexts": [], "cancellation_conditions": false, "cancellation_conditions_history": [], "cancellation_fee_preview": false, "fees": [] } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": [ "boolean", "string" ] }, "error_code": { "type": "string" }, "data": { "type": "object", "properties": { "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^transaction_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "transaction_012345abcdef_123456" ] }, "number": { "type": [ "number", "string" ] }, "amount": { "type": "number" }, "currency": { "type": "string" } }, "additionalProperties": true } }, "users": { "type": "array", "items": { "type": "object", "properties": { "active": { "type": "boolean" }, "participant": { "anyOf": [ { "type": "string", "pattern": "^participant_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "participant_012345abcdef_123456" ] }, { "const": false } ] }, "position": { "type": "string" }, "user": { "type": "string", "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "user_012345abcdef_123456" ] }, "pricecategory": { "type": "string", "pattern": "^pricecategory_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "pricecategory_012345abcdef_123456" ] }, "cert_visible": { "type": "boolean" }, "unnamed": { "type": "boolean" }, "multi_offer": { "type": "array", "items": { "type": "object", "properties": { "offer": { "type": "string", "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "offer_012345abcdef_123456" ] }, "pricecategory": { "type": "string", "pattern": "^pricecategory_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "pricecategory_012345abcdef_123456" ] } }, "additionalProperties": true } } }, "additionalProperties": true } }, "payments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^pay_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "pay_012345abcdef_123456" ] }, "paytrans": { "type": "string", "pattern": "^paytrans_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "paytrans_012345abcdef_123456" ] }, "refundable": { "type": "boolean" }, "payment": { "type": "object", "properties": { "type": { "type": "string" }, "token": { "type": "string" }, "currency": { "type": "string" }, "amount": { "type": "number" }, "refound": { "anyOf": [ { "type": "object", "properties": { "repaid_amount": { "type": "number" }, "refundable_amount": { "type": "number" } }, "additionalProperties": true }, { "const": false } ] }, "status": { "type": "integer" }, "date": { "description": "ISO-8601-Zeitwert von dQ; bei fehlendem/ungültigem gespeicherten Wert false.", "anyOf": [ { "type": "string", "format": "date-time" }, { "const": false } ] }, "user": { "type": "string", "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "user_012345abcdef_123456" ] } }, "additionalProperties": true } }, "additionalProperties": true } }, "promotion": { "anyOf": [ { "type": "object", "properties": { "code": { "type": "string" }, "currency": { "type": "string" }, "active": { "type": "boolean" }, "value": { "type": [ "number", "string" ] }, "id": { "type": "string", "pattern": "^promotion_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "promotion_012345abcdef_123456" ] }, "minimum_booking_amount": { "type": [ "number", "string" ] } }, "additionalProperties": true }, { "const": false } ] }, "multi_offer": { "type": "boolean" }, "dates": { "type": "array", "items": { "type": "string", "pattern": "^date_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "date_012345abcdef_123456" ] } }, "lessons_booking": { "type": "boolean" }, "invoice_address": { "type": "object", "properties": { "data0": { "type": "string" }, "data1": { "type": "string" }, "data2": { "type": "string" }, "data3": { "type": "string" }, "data4": { "type": "string" }, "data5": { "type": "string" }, "data6": { "anyOf": [ { "type": "string", "pattern": "^country_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "country_012345abcdef_123456" ] }, { "const": false } ] }, "data7": { "type": "string" }, "data8": { "type": "string" }, "active": { "type": "boolean" }, "b2b": { "type": "boolean" } }, "additionalProperties": true }, "label": { "anyOf": [ { "type": "string" }, { "const": false } ] }, "ip_address": { "type": "string" }, "offer": { "type": "string", "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "offer_012345abcdef_123456" ] }, "questiongroup": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "response_type": { "type": "string", "enum": [ "textarea", "radio", "text" ] }, "answer": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^question_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "question_012345abcdef_123456" ] }, "name": { "type": "string" }, "value": { "description": "Gespeicherte Freitext-/Zahlantwort oder öffentliche question-ID der Auswahloption." } }, "additionalProperties": true } }, "offer": { "type": "string", "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "offer_012345abcdef_123456" ] } }, "additionalProperties": true } }, { "type": "object", "additionalProperties": { "type": "object", "properties": { "title": { "type": "string" }, "response_type": { "type": "string", "enum": [ "textarea", "radio", "text" ] }, "answer": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^question_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "question_012345abcdef_123456" ] }, "name": { "type": "string" }, "value": { "description": "Gespeicherte Freitext-/Zahlantwort oder öffentliche question-ID der Auswahloption." } }, "additionalProperties": true } }, "offer": { "type": "string", "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "offer_012345abcdef_123456" ] } }, "additionalProperties": true } } ] }, "multi_offer_questiongroup": { "type": [ "object", "array" ], "additionalProperties": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "response_type": { "type": "string", "enum": [ "textarea", "radio", "text" ] }, "answer": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^question_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "question_012345abcdef_123456" ] }, "name": { "type": "string" }, "value": { "description": "Gespeicherte Freitext-/Zahlantwort oder öffentliche question-ID der Auswahloption." } }, "additionalProperties": true } }, "offer": { "type": "string", "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "offer_012345abcdef_123456" ] } }, "additionalProperties": true } }, { "type": "object", "additionalProperties": { "type": "object", "properties": { "title": { "type": "string" }, "response_type": { "type": "string", "enum": [ "textarea", "radio", "text" ] }, "answer": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^question_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "question_012345abcdef_123456" ] }, "name": { "type": "string" }, "value": { "description": "Gespeicherte Freitext-/Zahlantwort oder öffentliche question-ID der Auswahloption." } }, "additionalProperties": true } }, "offer": { "type": "string", "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "offer_012345abcdef_123456" ] } }, "additionalProperties": true } } ] }, "items": {} }, "deliverables": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "detail": { "type": "object", "properties": { "name": { "type": "string" }, "amount": { "type": "number" } }, "additionalProperties": true }, "count": { "type": [ "number", "string" ] }, "amount": { "type": [ "number", "string" ] }, "currency": { "type": "string" }, "vat": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "vat_012345abcdef_123456" ] }, "vat_percent": { "type": [ "number", "string" ] }, "vat_number": { "type": "string" } }, "additionalProperties": true }, { "const": false } ] } }, "additionalProperties": true } }, { "type": "object", "additionalProperties": { "type": "object", "properties": { "detail": { "type": "object", "properties": { "name": { "type": "string" }, "amount": { "type": "number" } }, "additionalProperties": true }, "count": { "type": [ "number", "string" ] }, "amount": { "type": [ "number", "string" ] }, "currency": { "type": "string" }, "vat": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "vat_012345abcdef_123456" ] }, "vat_percent": { "type": [ "number", "string" ] }, "vat_number": { "type": "string" } }, "additionalProperties": true }, { "const": false } ] } }, "additionalProperties": true } } ] }, "pricecategory": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^pricecategory_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "pricecategory_012345abcdef_123456" ] }, "count": { "type": "integer" }, "name": { "type": "string" }, "amount": { "type": "number" }, "default": { "type": "boolean" }, "offer": { "type": "string", "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "offer_012345abcdef_123456" ] } }, "additionalProperties": true } }, { "type": "object", "additionalProperties": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^pricecategory_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "pricecategory_012345abcdef_123456" ] }, "count": { "type": "integer" }, "name": { "type": "string" }, "amount": { "type": "number" }, "default": { "type": "boolean" }, "offer": { "type": "string", "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "offer_012345abcdef_123456" ] } }, "additionalProperties": true } } ] }, "legaltexts": { "type": "array", "items": { "type": "object", "properties": { "legaltext": { "type": "string", "pattern": "^legaltext_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "legaltext_012345abcdef_123456" ] }, "legalversion": { "anyOf": [ { "type": "string", "pattern": "^legalversion_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "legalversion_012345abcdef_123456" ] }, { "const": false } ] }, "accepted": { "type": "boolean" }, "require": { "type": "boolean" } }, "additionalProperties": true } }, "cancellation_conditions": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "Snapshot mit kontoabhängigen Stornierungs- und Widerrufsregeln." }, { "const": false } ] }, "cancellation_conditions_history": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Historieneinträge mit Akteur und den damaligen Snapshotwerten." } }, "cancellation_fee_preview": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "Aktuelle Gebührenvorschau gemäss Stornierungsbedingungen und Zahlungsstand." }, { "const": false } ] }, "fees": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Öffentliche Gebührenobjekte dieser Buchung." } } }, "additionalProperties": true }, "type": { "type": "string" } }, "additionalProperties": true } } }, "headers": { "X-Edoobox-Revision": { "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$" }, "description": "Rotated account revision supplied for the next action in one reviewed sequence." } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "example": { "success": false, "error": "ED40006" } } } }, "401": { "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.", "content": { "application/json": { "example": { "success": false, "error": "ED40103" } } } }, "402": { "description": "Missing/invalid action data or subscription/operation restriction.", "content": { "application/json": { "example": { "success": false, "error": "ED80100" } } } }, "403": { "description": "Permission denied. Browser CORS rejection may have an empty body.", "content": { "application/json": { "example": { "success": false, "error": "ED40340" } } } }, "404": { "description": "Unknown resource/action or unsupported method.", "content": { "application/json": { "example": { "success": false, "error": "ED80019" } } } }, "409": { "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "error": "ED40901", "error_code": "mutation_revision_conflict" } } } }, "422": { "description": "Validation failed.", "content": { "application/json": { "example": { "success": false, "error": "ED80020" } } } }, "429": { "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.", "content": { "application/json": { "example": { "success": false, "error": "ED42902" } } }, "headers": { "Retry-After": { "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.", "schema": { "type": "string", "examples": [ "30" ] } } } }, "502": { "description": "Server-side operation failed.", "content": { "application/json": { "example": { "success": false, "error": "ED50201" } } } }, "503": { "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.", "headers": { "Retry-After": { "schema": { "type": "integer", "const": 1 } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "error": "ED50301", "error_code": "mutation_revision_busy" } } } } } ``` ## Aufrufbeispiele Anpassen vor dem Ausführen. Platzhalter und veröffentlichte Beispiele sind synthetisch. Die Beispiele senden hier keine Anfrage; sie ergänzen keine unbekannten Pflichtfelder. ### cURL ```sh # Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich. # filter: komplexen Wert vorab gemäss content/style/explode serialisieren; das Beispiel verwendet einen vorbereiteten Wert. : "${API_ORIGIN:?API_ORIGIN setzen}" : "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}" : "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}" : "${QUERY_FILTER:?QUERY_FILTER setzen}" curl --request 'GET' \ --url "${API_ORIGIN%/}"'/v2/booking/list/data' \ --url-query 'filter='"${QUERY_FILTER}" \ --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \ --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" ``` ### JavaScript (Node.js) ```javascript // Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich. // filter: komplexen Wert vorab gemäss content/style/explode serialisieren; das Beispiel verwendet einen vorbereiteten Wert. const required = (name) => { const value = process.env[name]; if (!value) throw new Error(`Set ${name}`); return value; }; let path = "/v2/booking/list/data"; const origin = required('API_ORIGIN'); const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path); url.searchParams.append("filter", required("QUERY_FILTER")); const headers = {}; headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH"); headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT"); const response = await fetch(url, { method: "GET", headers, redirect: 'manual' }); const text = await response.text(); console.log(response.status, text); // HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen. ``` ### Python ```python # Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich. # filter: komplexen Wert vorab gemäss content/style/explode serialisieren; das Beispiel verwendet einen vorbereiteten Wert. import os import urllib.parse import urllib.request import urllib.error path = "/v2/booking/list/data" url = os.environ["API_ORIGIN"].rstrip("/") + path url += "?" + urllib.parse.urlencode([("filter", os.environ["QUERY_FILTER"])]) headers = {} headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"] headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"] # Redirects nicht automatisch verfolgen. class NoRedirect(urllib.request.HTTPRedirectHandler): def redirect_request(self, req, fp, code, msg, headers, newurl): return None request = urllib.request.Request(url, headers=headers, method="GET") try: response = urllib.request.build_opener(NoRedirect).open(request, timeout=30) except urllib.error.HTTPError as error: response = error print(response.status, response.read().decode("utf-8", errors="replace")) # HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen. ``` ## Vollständige Operationsdefinition und edoobox-Hinweise Alle Originalfelder einschliesslich `x-edoobox-*`, requestBody und responses bleiben erhalten. Teilweise dokumentierte Schemata sind kein vollständiger Validierungsvertrag. ```json { "operationId": "get_v2_booking_list_data", "summary": "Vollständige Buchungsübersicht lesen", "description": "Liest den gespeicherten Buchungsstand mit Teilnehmerpositionen, Preisen, Zusatzleistungen, Antworten, Zahlungen, Rechnungsadresse, Rechts- und Stornierungsinformationen. Genau eine bestehende Buchung wird über die Pfad-ID oder den ersten filter-Eintrag mit property=id ausgewählt; dies ist keine Listenabfrage.", "tags": [ "booking" ], "security": [ { "bearerAuth": [], "accountContext": [] }, { "sessionCookie": [], "accountContext": [] } ], "parameters": [ { "name": "filter", "in": "query", "required": true, "description": "Die erste Filterposition muss die konkrete Buchungs-ID enthalten.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "expression": { "type": "string" }, "value": {} }, "additionalProperties": true, "required": [ "property", "value" ] }, "allOf": [ { "contains": { "type": "object", "properties": { "property": { "const": "id" }, "value": { "type": "string", "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "booking_012345abcdef_123456" ], "description": "Öffentliche v2-ID aus dem ausgewählten Konto." } }, "additionalProperties": true, "required": [ "property", "value" ] } } ], "prefixItems": [ { "type": "object", "properties": { "property": { "const": "id" }, "value": { "type": "string", "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "booking_012345abcdef_123456" ], "description": "Öffentliche v2-ID aus dem ausgewählten Konto." } }, "additionalProperties": true, "required": [ "property", "value" ] } ], "minItems": 1 }, "example": [ { "property": "id", "value": "booking_012345abcdef_123456" } ] } } }, { "name": "language", "in": "header", "required": false, "description": "Account language code, where the resource supports setLanguage().", "schema": { "type": "string", "examples": [ "de" ] } }, { "name": "X-Edoobox-If-Revision", "in": "header", "required": false, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "examples": [ "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" ] }, "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review." } ], "responses": { "200": { "description": "Erweiterte fachliche Rückgabe in data; die aufgeführten Sammlungen können leer sein und enthalten ausschliesslich öffentliche Referenzen.", "content": { "application/json": { "example": { "success": true, "error": false, "data": { "transactions": [ { "id": "transaction_012345abcdef_123456", "number": "2026-1001", "amount": 120, "currency": "CHF" } ], "users": [ { "active": true, "participant": "participant_012345abcdef_123456", "position": "person", "user": "user_012345abcdef_123456", "pricecategory": "pricecategory_012345abcdef_123456", "cert_visible": false } ], "payments": [], "promotion": false, "multi_offer": false, "dates": [], "lessons_booking": false, "invoice_address": { "active": false, "b2b": false, "data0": "", "data1": "", "data2": "", "data3": "", "data4": "", "data5": "", "data7": "", "data8": "" }, "label": false, "ip_address": "192.0.2.1", "offer": "offer_012345abcdef_123456", "questiongroup": [], "multi_offer_questiongroup": [], "deliverables": [], "pricecategory": { "pricecategory_012345abcdef_123456": { "id": "pricecategory_012345abcdef_123456", "count": 1, "name": "Standard", "amount": 120, "default": true, "offer": "offer_012345abcdef_123456" } }, "legaltexts": [], "cancellation_conditions": false, "cancellation_conditions_history": [], "cancellation_fee_preview": false, "fees": [] } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": [ "boolean", "string" ] }, "error_code": { "type": "string" }, "data": { "type": "object", "properties": { "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^transaction_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "transaction_012345abcdef_123456" ] }, "number": { "type": [ "number", "string" ] }, "amount": { "type": "number" }, "currency": { "type": "string" } }, "additionalProperties": true } }, "users": { "type": "array", "items": { "type": "object", "properties": { "active": { "type": "boolean" }, "participant": { "anyOf": [ { "type": "string", "pattern": "^participant_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "participant_012345abcdef_123456" ] }, { "const": false } ] }, "position": { "type": "string" }, "user": { "type": "string", "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "user_012345abcdef_123456" ] }, "pricecategory": { "type": "string", "pattern": "^pricecategory_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "pricecategory_012345abcdef_123456" ] }, "cert_visible": { "type": "boolean" }, "unnamed": { "type": "boolean" }, "multi_offer": { "type": "array", "items": { "type": "object", "properties": { "offer": { "type": "string", "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "offer_012345abcdef_123456" ] }, "pricecategory": { "type": "string", "pattern": "^pricecategory_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "pricecategory_012345abcdef_123456" ] } }, "additionalProperties": true } } }, "additionalProperties": true } }, "payments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^pay_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "pay_012345abcdef_123456" ] }, "paytrans": { "type": "string", "pattern": "^paytrans_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "paytrans_012345abcdef_123456" ] }, "refundable": { "type": "boolean" }, "payment": { "type": "object", "properties": { "type": { "type": "string" }, "token": { "type": "string" }, "currency": { "type": "string" }, "amount": { "type": "number" }, "refound": { "anyOf": [ { "type": "object", "properties": { "repaid_amount": { "type": "number" }, "refundable_amount": { "type": "number" } }, "additionalProperties": true }, { "const": false } ] }, "status": { "type": "integer" }, "date": { "description": "ISO-8601-Zeitwert von dQ; bei fehlendem/ungültigem gespeicherten Wert false.", "anyOf": [ { "type": "string", "format": "date-time" }, { "const": false } ] }, "user": { "type": "string", "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "user_012345abcdef_123456" ] } }, "additionalProperties": true } }, "additionalProperties": true } }, "promotion": { "anyOf": [ { "type": "object", "properties": { "code": { "type": "string" }, "currency": { "type": "string" }, "active": { "type": "boolean" }, "value": { "type": [ "number", "string" ] }, "id": { "type": "string", "pattern": "^promotion_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "promotion_012345abcdef_123456" ] }, "minimum_booking_amount": { "type": [ "number", "string" ] } }, "additionalProperties": true }, { "const": false } ] }, "multi_offer": { "type": "boolean" }, "dates": { "type": "array", "items": { "type": "string", "pattern": "^date_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "date_012345abcdef_123456" ] } }, "lessons_booking": { "type": "boolean" }, "invoice_address": { "type": "object", "properties": { "data0": { "type": "string" }, "data1": { "type": "string" }, "data2": { "type": "string" }, "data3": { "type": "string" }, "data4": { "type": "string" }, "data5": { "type": "string" }, "data6": { "anyOf": [ { "type": "string", "pattern": "^country_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "country_012345abcdef_123456" ] }, { "const": false } ] }, "data7": { "type": "string" }, "data8": { "type": "string" }, "active": { "type": "boolean" }, "b2b": { "type": "boolean" } }, "additionalProperties": true }, "label": { "anyOf": [ { "type": "string" }, { "const": false } ] }, "ip_address": { "type": "string" }, "offer": { "type": "string", "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "offer_012345abcdef_123456" ] }, "questiongroup": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "response_type": { "type": "string", "enum": [ "textarea", "radio", "text" ] }, "answer": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^question_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "question_012345abcdef_123456" ] }, "name": { "type": "string" }, "value": { "description": "Gespeicherte Freitext-/Zahlantwort oder öffentliche question-ID der Auswahloption." } }, "additionalProperties": true } }, "offer": { "type": "string", "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "offer_012345abcdef_123456" ] } }, "additionalProperties": true } }, { "type": "object", "additionalProperties": { "type": "object", "properties": { "title": { "type": "string" }, "response_type": { "type": "string", "enum": [ "textarea", "radio", "text" ] }, "answer": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^question_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "question_012345abcdef_123456" ] }, "name": { "type": "string" }, "value": { "description": "Gespeicherte Freitext-/Zahlantwort oder öffentliche question-ID der Auswahloption." } }, "additionalProperties": true } }, "offer": { "type": "string", "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "offer_012345abcdef_123456" ] } }, "additionalProperties": true } } ] }, "multi_offer_questiongroup": { "type": [ "object", "array" ], "additionalProperties": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "response_type": { "type": "string", "enum": [ "textarea", "radio", "text" ] }, "answer": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^question_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "question_012345abcdef_123456" ] }, "name": { "type": "string" }, "value": { "description": "Gespeicherte Freitext-/Zahlantwort oder öffentliche question-ID der Auswahloption." } }, "additionalProperties": true } }, "offer": { "type": "string", "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "offer_012345abcdef_123456" ] } }, "additionalProperties": true } }, { "type": "object", "additionalProperties": { "type": "object", "properties": { "title": { "type": "string" }, "response_type": { "type": "string", "enum": [ "textarea", "radio", "text" ] }, "answer": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^question_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "question_012345abcdef_123456" ] }, "name": { "type": "string" }, "value": { "description": "Gespeicherte Freitext-/Zahlantwort oder öffentliche question-ID der Auswahloption." } }, "additionalProperties": true } }, "offer": { "type": "string", "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "offer_012345abcdef_123456" ] } }, "additionalProperties": true } } ] }, "items": {} }, "deliverables": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "detail": { "type": "object", "properties": { "name": { "type": "string" }, "amount": { "type": "number" } }, "additionalProperties": true }, "count": { "type": [ "number", "string" ] }, "amount": { "type": [ "number", "string" ] }, "currency": { "type": "string" }, "vat": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "vat_012345abcdef_123456" ] }, "vat_percent": { "type": [ "number", "string" ] }, "vat_number": { "type": "string" } }, "additionalProperties": true }, { "const": false } ] } }, "additionalProperties": true } }, { "type": "object", "additionalProperties": { "type": "object", "properties": { "detail": { "type": "object", "properties": { "name": { "type": "string" }, "amount": { "type": "number" } }, "additionalProperties": true }, "count": { "type": [ "number", "string" ] }, "amount": { "type": [ "number", "string" ] }, "currency": { "type": "string" }, "vat": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "vat_012345abcdef_123456" ] }, "vat_percent": { "type": [ "number", "string" ] }, "vat_number": { "type": "string" } }, "additionalProperties": true }, { "const": false } ] } }, "additionalProperties": true } } ] }, "pricecategory": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^pricecategory_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "pricecategory_012345abcdef_123456" ] }, "count": { "type": "integer" }, "name": { "type": "string" }, "amount": { "type": "number" }, "default": { "type": "boolean" }, "offer": { "type": "string", "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "offer_012345abcdef_123456" ] } }, "additionalProperties": true } }, { "type": "object", "additionalProperties": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^pricecategory_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "pricecategory_012345abcdef_123456" ] }, "count": { "type": "integer" }, "name": { "type": "string" }, "amount": { "type": "number" }, "default": { "type": "boolean" }, "offer": { "type": "string", "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "offer_012345abcdef_123456" ] } }, "additionalProperties": true } } ] }, "legaltexts": { "type": "array", "items": { "type": "object", "properties": { "legaltext": { "type": "string", "pattern": "^legaltext_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "legaltext_012345abcdef_123456" ] }, "legalversion": { "anyOf": [ { "type": "string", "pattern": "^legalversion_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "legalversion_012345abcdef_123456" ] }, { "const": false } ] }, "accepted": { "type": "boolean" }, "require": { "type": "boolean" } }, "additionalProperties": true } }, "cancellation_conditions": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "Snapshot mit kontoabhängigen Stornierungs- und Widerrufsregeln." }, { "const": false } ] }, "cancellation_conditions_history": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Historieneinträge mit Akteur und den damaligen Snapshotwerten." } }, "cancellation_fee_preview": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "Aktuelle Gebührenvorschau gemäss Stornierungsbedingungen und Zahlungsstand." }, { "const": false } ] }, "fees": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Öffentliche Gebührenobjekte dieser Buchung." } } }, "additionalProperties": true }, "type": { "type": "string" } }, "additionalProperties": true } } }, "headers": { "X-Edoobox-Revision": { "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$" }, "description": "Rotated account revision supplied for the next action in one reviewed sequence." } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "example": { "success": false, "error": "ED40006" } } } }, "401": { "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.", "content": { "application/json": { "example": { "success": false, "error": "ED40103" } } } }, "402": { "description": "Missing/invalid action data or subscription/operation restriction.", "content": { "application/json": { "example": { "success": false, "error": "ED80100" } } } }, "403": { "description": "Permission denied. Browser CORS rejection may have an empty body.", "content": { "application/json": { "example": { "success": false, "error": "ED40340" } } } }, "404": { "description": "Unknown resource/action or unsupported method.", "content": { "application/json": { "example": { "success": false, "error": "ED80019" } } } }, "409": { "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "error": "ED40901", "error_code": "mutation_revision_conflict" } } } }, "422": { "description": "Validation failed.", "content": { "application/json": { "example": { "success": false, "error": "ED80020" } } } }, "429": { "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.", "content": { "application/json": { "example": { "success": false, "error": "ED42902" } } }, "headers": { "Retry-After": { "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.", "schema": { "type": "string", "examples": [ "30" ] } } } }, "502": { "description": "Server-side operation failed.", "content": { "application/json": { "example": { "success": false, "error": "ED50201" } } } }, "503": { "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.", "headers": { "Retry-After": { "schema": { "type": "integer", "const": 1 } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "error": "ED50301", "error_code": "mutation_revision_busy" } } } } }, "x-edoobox-mutates-state": false, "x-edoobox-runtimeMutationGuard": true, "x-edoobox-get-effect": "read", "x-edoobox-documentationReview": { "file": "docs/openapi/operation-contracts/02-booking-users.json", "notes": [] }, "x-edoobox-source": { "file": "application/models/v2/Booking.php", "method": "getBooking", "line": 556, "branch": { "file": "application/models/v2/Booking.php", "line": 787 } }, "x-edoobox-documentationStatus": "reviewed", "x-edoobox-readOnly": true, "x-edoobox-safeForAutomation": false, "x-edoobox-permission": { "resource": "booking", "short": "book", "checkedByDispatcher": true, "levels": [ 1, 3, 4 ], "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope." } } ```