# GET /v2/booking/{id} Buchungen und Buchungsstatus lesen Liest Buchungen des ausgewählten Kontos mit Angebot, Buchungsinhaber, Wartelisten-/Stornierungsstatus und optionalen Transaktionen beziehungsweise Teilnehmern. Eine Pfad-ID wird als erster id-Filter behandelt; ohne Pfad-ID begrenzen filter, fields, order und limit die Sammlung. Auch eine einzelne ID liefert das allgemeine Sammlungsformat. - Operation-ID: get_v2_booking_id - Dokumentation: /docs/api/v2/operations/get-v2-booking-id-3ff9b7d1c5a2/ - 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: ja, siehe Voraussetzungen ## 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 | | --- | --- | --- | --- | | id | path | ja | v2 object identifier in the selected account. | | fields | query | nein | JSON-encoded fields value consumed by RequestAPIData / API_DATA; specific actions may ignore it. | | filter | query | nein | JSON-encoded filter value consumed by RequestAPIData / API_DATA; specific actions may ignore it. | | limit | query | nein | JSON-encoded limit value consumed by RequestAPIData / API_DATA; specific actions may ignore it. | | order | query | nein | JSON-encoded order value consumed by RequestAPIData / API_DATA; specific actions may ignore it. | | response_type | query | nein | Controls generic collection representation; default is an ID-keyed object. | | language | header | nein | Account language code, where the resource supports setLanguage(). | ### Vollständige wirksame Parameterdefinitionen ```json [ { "name": "id", "in": "path", "required": true, "description": "v2 object identifier in the selected account.", "schema": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "booking_012345abcdef_123456" ] } }, { "name": "fields", "in": "query", "required": false, "description": "JSON-encoded fields value consumed by RequestAPIData / API_DATA; specific actions may ignore it.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "examples": [ [ "id" ] ] }, "example": [ "id" ] } } }, { "name": "filter", "in": "query", "required": false, "description": "JSON-encoded filter value consumed by RequestAPIData / API_DATA; specific actions may ignore it.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "expression": { "type": "string" }, "value": {} }, "additionalProperties": true }, "examples": [ [ { "property": "id", "expression": "=", "value": "booking_012345abcdef_123456" } ] ] }, "example": [ { "property": "id", "expression": "=", "value": "booking_012345abcdef_123456" } ] } } }, { "name": "limit", "in": "query", "required": false, "description": "JSON-encoded limit value consumed by RequestAPIData / API_DATA; specific actions may ignore it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "default": 0 }, "reply": { "type": "integer", "maximum": 2000, "default": 100 } }, "examples": [ { "start": 0, "reply": 25 } ] }, "example": { "start": 0, "reply": 25 } } } }, { "name": "order", "in": "query", "required": false, "description": "JSON-encoded order value consumed by RequestAPIData / API_DATA; specific actions may ignore it.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "value": { "type": "string", "enum": [ "ASC", "DESC" ] } }, "additionalProperties": true }, "examples": [ [ { "property": "id", "value": "ASC" } ] ] }, "example": [ { "property": "id", "value": "ASC" } ] } } }, { "name": "response_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "array", "object" ], "examples": [ "array" ] }, "description": "Controls generic collection representation; default is an ID-keyed object." }, { "name": "language", "in": "header", "required": false, "description": "Account language code, where the resource supports setLanguage().", "schema": { "type": "string", "examples": [ "de" ] } } ] ``` ## 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": "Response; inspect error and success as legacy failures may also use HTTP 200.", "content": { "application/json": { "example": { "success": true, "error": false, "data": { "booking_012345abcdef_123456": { "id": "booking_012345abcdef_123456" } }, "limit": { "start": 0, "reply": 100, "total": 1 } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": [ "boolean", "string" ] }, "error_code": { "type": "string" }, "data": { "description": "Generic collection (ID-keyed object by default, array for response_type=array) or resource object. Structure fields are partial and action-dependent.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "booking_012345abcdef_123456" ] }, "time": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 32, "anyOf": [ { "type": "string" }, { "const": false } ] }, "offer": { "description": "Existing offer in the selected account; required by the native booking-create hook.\n\nResponse field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 43, "anyOf": [ { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "offer_012345abcdef_123456" ] }, { "const": false }, { "type": "null" } ] }, "owner": { "description": "Existing booking owner (user v2 ID); required for booking creation, immutable on ordinary update.\n\nResponse field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 58, "anyOf": [ { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "owner_012345abcdef_123456" ] }, { "const": false }, { "type": "null" } ] }, "canceled": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 72 }, "mustpay": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 82 }, "waiting_list": { "description": "Create as a waiting-list booking; lesson-based offers reject this mode in Bookingfunc::_addBooking.\n\nResponse field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 93 }, "label": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 103, "type": "string" }, "users": { "type": "array", "items": { "type": "object", "properties": { "participant": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." }, "user": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." }, "pricecategory": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "additionalProperties": true, "required": [ "participant", "user", "pricecategory" ] }, "x-edoobox-contractSource": [ { "file": "application/models/v2/Booking.php", "line": 117, "reason": "Response builds participant/user/pricecategory objects inside an array.", "sha256": "78bb2e6d2875243f1267a8724ab29e406b7c93dd351c50f6a270f9c184ae81b5" } ] }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "transaction": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." }, "number": { "type": "number" }, "amount": { "type": "number" }, "currency": { "type": "string" } }, "additionalProperties": true, "required": [ "transaction", "number", "amount", "currency" ] }, "x-edoobox-contractSource": [ { "file": "application/models/v2/Booking.php", "line": 139, "reason": "Response builds transaction/number/amount/currency objects inside an array.", "sha256": "78bb2e6d2875243f1267a8724ab29e406b7c93dd351c50f6a270f9c184ae81b5" } ] } }, "additionalProperties": true }, { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "booking_012345abcdef_123456" ] }, "time": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 32, "anyOf": [ { "type": "string" }, { "const": false } ] }, "offer": { "description": "Existing offer in the selected account; required by the native booking-create hook.\n\nResponse field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 43, "anyOf": [ { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "offer_012345abcdef_123456" ] }, { "const": false }, { "type": "null" } ] }, "owner": { "description": "Existing booking owner (user v2 ID); required for booking creation, immutable on ordinary update.\n\nResponse field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 58, "anyOf": [ { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "owner_012345abcdef_123456" ] }, { "const": false }, { "type": "null" } ] }, "canceled": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 72 }, "mustpay": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 82 }, "waiting_list": { "description": "Create as a waiting-list booking; lesson-based offers reject this mode in Bookingfunc::_addBooking.\n\nResponse field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 93 }, "label": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 103, "type": "string" }, "users": { "type": "array", "items": { "type": "object", "properties": { "participant": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." }, "user": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." }, "pricecategory": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "additionalProperties": true, "required": [ "participant", "user", "pricecategory" ] }, "x-edoobox-contractSource": [ { "file": "application/models/v2/Booking.php", "line": 117, "reason": "Response builds participant/user/pricecategory objects inside an array.", "sha256": "78bb2e6d2875243f1267a8724ab29e406b7c93dd351c50f6a270f9c184ae81b5" } ] }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "transaction": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." }, "number": { "type": "number" }, "amount": { "type": "number" }, "currency": { "type": "string" } }, "additionalProperties": true, "required": [ "transaction", "number", "amount", "currency" ] }, "x-edoobox-contractSource": [ { "file": "application/models/v2/Booking.php", "line": 139, "reason": "Response builds transaction/number/amount/currency objects inside an array.", "sha256": "78bb2e6d2875243f1267a8724ab29e406b7c93dd351c50f6a270f9c184ae81b5" } ] } }, "additionalProperties": true } }, { "type": "object", "additionalProperties": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "booking_012345abcdef_123456" ] }, "time": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 32, "anyOf": [ { "type": "string" }, { "const": false } ] }, "offer": { "description": "Existing offer in the selected account; required by the native booking-create hook.\n\nResponse field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 43, "anyOf": [ { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "offer_012345abcdef_123456" ] }, { "const": false }, { "type": "null" } ] }, "owner": { "description": "Existing booking owner (user v2 ID); required for booking creation, immutable on ordinary update.\n\nResponse field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 58, "anyOf": [ { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "owner_012345abcdef_123456" ] }, { "const": false }, { "type": "null" } ] }, "canceled": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 72 }, "mustpay": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 82 }, "waiting_list": { "description": "Create as a waiting-list booking; lesson-based offers reject this mode in Bookingfunc::_addBooking.\n\nResponse field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 93 }, "label": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 103, "type": "string" }, "users": { "type": "array", "items": { "type": "object", "properties": { "participant": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." }, "user": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." }, "pricecategory": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "additionalProperties": true, "required": [ "participant", "user", "pricecategory" ] }, "x-edoobox-contractSource": [ { "file": "application/models/v2/Booking.php", "line": 117, "reason": "Response builds participant/user/pricecategory objects inside an array.", "sha256": "78bb2e6d2875243f1267a8724ab29e406b7c93dd351c50f6a270f9c184ae81b5" } ] }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "transaction": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." }, "number": { "type": "number" }, "amount": { "type": "number" }, "currency": { "type": "string" } }, "additionalProperties": true, "required": [ "transaction", "number", "amount", "currency" ] }, "x-edoobox-contractSource": [ { "file": "application/models/v2/Booking.php", "line": 139, "reason": "Response builds transaction/number/amount/currency objects inside an array.", "sha256": "78bb2e6d2875243f1267a8724ab29e406b7c93dd351c50f6a270f9c184ae81b5" } ] } }, "additionalProperties": true } } ] }, "type": { "type": "string" } }, "additionalProperties": true } } } }, "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" } } } }, "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" } } } } } ``` ## 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. # cURL: PATH_* bereits URL-kodiert setzen. JavaScript/Python kodieren die unveränderten Pfadwerte selbst. : "${API_ORIGIN:?API_ORIGIN setzen}" : "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}" : "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}" : "${PATH_ID:?PATH_ID setzen}" curl --request 'GET' \ --url "${API_ORIGIN%/}"'/v2/booking/'"${PATH_ID}"'' \ --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \ --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" ``` ### JavaScript (Node.js) ```javascript // Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich. const required = (name) => { const value = process.env[name]; if (!value) throw new Error(`Set ${name}`); return value; }; let path = "/v2/booking/{id}"; path = path.replaceAll("{id}", encodeURIComponent(required("PATH_ID"))); const origin = required('API_ORIGIN'); const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path); 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. import os import urllib.parse import urllib.request import urllib.error path = "/v2/booking/{id}" path = path.replace("{id}", urllib.parse.quote(os.environ["PATH_ID"], safe="")) url = os.environ["API_ORIGIN"].rstrip("/") + path 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_id", "summary": "Buchungen und Buchungsstatus lesen", "description": "Liest Buchungen des ausgewählten Kontos mit Angebot, Buchungsinhaber, Wartelisten-/Stornierungsstatus und optionalen Transaktionen beziehungsweise Teilnehmern. Eine Pfad-ID wird als erster id-Filter behandelt; ohne Pfad-ID begrenzen filter, fields, order und limit die Sammlung. Auch eine einzelne ID liefert das allgemeine Sammlungsformat.", "tags": [ "booking" ], "security": [ { "bearerAuth": [], "accountContext": [] }, { "sessionCookie": [], "accountContext": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "v2 object identifier in the selected account.", "schema": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "booking_012345abcdef_123456" ] } }, { "name": "fields", "in": "query", "required": false, "description": "JSON-encoded fields value consumed by RequestAPIData / API_DATA; specific actions may ignore it.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "examples": [ [ "id" ] ] }, "example": [ "id" ] } } }, { "name": "filter", "in": "query", "required": false, "description": "JSON-encoded filter value consumed by RequestAPIData / API_DATA; specific actions may ignore it.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "expression": { "type": "string" }, "value": {} }, "additionalProperties": true }, "examples": [ [ { "property": "id", "expression": "=", "value": "booking_012345abcdef_123456" } ] ] }, "example": [ { "property": "id", "expression": "=", "value": "booking_012345abcdef_123456" } ] } } }, { "name": "limit", "in": "query", "required": false, "description": "JSON-encoded limit value consumed by RequestAPIData / API_DATA; specific actions may ignore it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "default": 0 }, "reply": { "type": "integer", "maximum": 2000, "default": 100 } }, "examples": [ { "start": 0, "reply": 25 } ] }, "example": { "start": 0, "reply": 25 } } } }, { "name": "order", "in": "query", "required": false, "description": "JSON-encoded order value consumed by RequestAPIData / API_DATA; specific actions may ignore it.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "value": { "type": "string", "enum": [ "ASC", "DESC" ] } }, "additionalProperties": true }, "examples": [ [ { "property": "id", "value": "ASC" } ] ] }, "example": [ { "property": "id", "value": "ASC" } ] } } }, { "name": "response_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "array", "object" ], "examples": [ "array" ] }, "description": "Controls generic collection representation; default is an ID-keyed object." }, { "name": "language", "in": "header", "required": false, "description": "Account language code, where the resource supports setLanguage().", "schema": { "type": "string", "examples": [ "de" ] } } ], "responses": { "200": { "description": "Response; inspect error and success as legacy failures may also use HTTP 200.", "content": { "application/json": { "example": { "success": true, "error": false, "data": { "booking_012345abcdef_123456": { "id": "booking_012345abcdef_123456" } }, "limit": { "start": 0, "reply": 100, "total": 1 } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": [ "boolean", "string" ] }, "error_code": { "type": "string" }, "data": { "description": "Generic collection (ID-keyed object by default, array for response_type=array) or resource object. Structure fields are partial and action-dependent.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "booking_012345abcdef_123456" ] }, "time": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 32, "anyOf": [ { "type": "string" }, { "const": false } ] }, "offer": { "description": "Existing offer in the selected account; required by the native booking-create hook.\n\nResponse field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 43, "anyOf": [ { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "offer_012345abcdef_123456" ] }, { "const": false }, { "type": "null" } ] }, "owner": { "description": "Existing booking owner (user v2 ID); required for booking creation, immutable on ordinary update.\n\nResponse field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 58, "anyOf": [ { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "owner_012345abcdef_123456" ] }, { "const": false }, { "type": "null" } ] }, "canceled": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 72 }, "mustpay": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 82 }, "waiting_list": { "description": "Create as a waiting-list booking; lesson-based offers reject this mode in Bookingfunc::_addBooking.\n\nResponse field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 93 }, "label": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 103, "type": "string" }, "users": { "type": "array", "items": { "type": "object", "properties": { "participant": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." }, "user": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." }, "pricecategory": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "additionalProperties": true, "required": [ "participant", "user", "pricecategory" ] }, "x-edoobox-contractSource": [ { "file": "application/models/v2/Booking.php", "line": 117, "reason": "Response builds participant/user/pricecategory objects inside an array.", "sha256": "78bb2e6d2875243f1267a8724ab29e406b7c93dd351c50f6a270f9c184ae81b5" } ] }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "transaction": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." }, "number": { "type": "number" }, "amount": { "type": "number" }, "currency": { "type": "string" } }, "additionalProperties": true, "required": [ "transaction", "number", "amount", "currency" ] }, "x-edoobox-contractSource": [ { "file": "application/models/v2/Booking.php", "line": 139, "reason": "Response builds transaction/number/amount/currency objects inside an array.", "sha256": "78bb2e6d2875243f1267a8724ab29e406b7c93dd351c50f6a270f9c184ae81b5" } ] } }, "additionalProperties": true }, { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "booking_012345abcdef_123456" ] }, "time": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 32, "anyOf": [ { "type": "string" }, { "const": false } ] }, "offer": { "description": "Existing offer in the selected account; required by the native booking-create hook.\n\nResponse field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 43, "anyOf": [ { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "offer_012345abcdef_123456" ] }, { "const": false }, { "type": "null" } ] }, "owner": { "description": "Existing booking owner (user v2 ID); required for booking creation, immutable on ordinary update.\n\nResponse field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 58, "anyOf": [ { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "owner_012345abcdef_123456" ] }, { "const": false }, { "type": "null" } ] }, "canceled": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 72 }, "mustpay": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 82 }, "waiting_list": { "description": "Create as a waiting-list booking; lesson-based offers reject this mode in Bookingfunc::_addBooking.\n\nResponse field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 93 }, "label": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 103, "type": "string" }, "users": { "type": "array", "items": { "type": "object", "properties": { "participant": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." }, "user": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." }, "pricecategory": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "additionalProperties": true, "required": [ "participant", "user", "pricecategory" ] }, "x-edoobox-contractSource": [ { "file": "application/models/v2/Booking.php", "line": 117, "reason": "Response builds participant/user/pricecategory objects inside an array.", "sha256": "78bb2e6d2875243f1267a8724ab29e406b7c93dd351c50f6a270f9c184ae81b5" } ] }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "transaction": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." }, "number": { "type": "number" }, "amount": { "type": "number" }, "currency": { "type": "string" } }, "additionalProperties": true, "required": [ "transaction", "number", "amount", "currency" ] }, "x-edoobox-contractSource": [ { "file": "application/models/v2/Booking.php", "line": 139, "reason": "Response builds transaction/number/amount/currency objects inside an array.", "sha256": "78bb2e6d2875243f1267a8724ab29e406b7c93dd351c50f6a270f9c184ae81b5" } ] } }, "additionalProperties": true } }, { "type": "object", "additionalProperties": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "booking_012345abcdef_123456" ] }, "time": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 32, "anyOf": [ { "type": "string" }, { "const": false } ] }, "offer": { "description": "Existing offer in the selected account; required by the native booking-create hook.\n\nResponse field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 43, "anyOf": [ { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "offer_012345abcdef_123456" ] }, { "const": false }, { "type": "null" } ] }, "owner": { "description": "Existing booking owner (user v2 ID); required for booking creation, immutable on ordinary update.\n\nResponse field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 58, "anyOf": [ { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "owner_012345abcdef_123456" ] }, { "const": false }, { "type": "null" } ] }, "canceled": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 72 }, "mustpay": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 82 }, "waiting_list": { "description": "Create as a waiting-list booking; lesson-based offers reject this mode in Bookingfunc::_addBooking.\n\nResponse field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 93 }, "label": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 103, "type": "string" }, "users": { "type": "array", "items": { "type": "object", "properties": { "participant": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." }, "user": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." }, "pricecategory": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "additionalProperties": true, "required": [ "participant", "user", "pricecategory" ] }, "x-edoobox-contractSource": [ { "file": "application/models/v2/Booking.php", "line": 117, "reason": "Response builds participant/user/pricecategory objects inside an array.", "sha256": "78bb2e6d2875243f1267a8724ab29e406b7c93dd351c50f6a270f9c184ae81b5" } ] }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "transaction": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." }, "number": { "type": "number" }, "amount": { "type": "number" }, "currency": { "type": "string" } }, "additionalProperties": true, "required": [ "transaction", "number", "amount", "currency" ] }, "x-edoobox-contractSource": [ { "file": "application/models/v2/Booking.php", "line": 139, "reason": "Response builds transaction/number/amount/currency objects inside an array.", "sha256": "78bb2e6d2875243f1267a8724ab29e406b7c93dd351c50f6a270f9c184ae81b5" } ] } }, "additionalProperties": true } } ] }, "type": { "type": "string" } }, "additionalProperties": true } } } }, "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" } } } }, "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" } } } } }, "x-edoobox-mutates-state": false, "x-edoobox-runtimeMutationGuard": false, "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 }, "x-edoobox-documentationStatus": "reviewed", "x-edoobox-readOnly": true, "x-edoobox-safeForAutomation": true, "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." } } ```