# POST /v2/design Buchungsdesign anlegen Erstellt ein Buchungsdesign durch Kopieren eines bestehenden eigenen oder öffentlichen Vorlage-Designs. Zusätzlich zu name ist data.design erforderlich. Widgets werden kopiert, fehlende Standard-Formularfelder ergänzt und das Buchungswarenkorb-Verhalten sowie Bootstrap bei fehlender expliziter Angabe übernommen. data akzeptiert einen Datensatz oder ein Array mit bis zu 100 Datensätzen; bei einem Batch enthält data.id ein Array öffentlicher IDs. - Operation-ID: post_v2_design - Dokumentation: /docs/api/v2/operations/post-v2-design-40bba1ac0873/ - OpenAPI-Version: 3.2.1 - Vollständige Spezifikation: /docs/api/v2/openapi.json - Dokumentationsstatus: reviewed - Ändert Zustand: ja - 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 | | --- | --- | --- | --- | | 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": "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 ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "id": false, "bootstrap": { "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": [ "bootstrap_012345abcdef_123456" ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 39 }, "name": { "x-edoobox-canonicalType": "string", "x-edoobox-maxStoredLength": 200, "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.", "examples": [ "Example" ], "x-edoobox-requiredOnCreate": true, "x-edoobox-sourceLine": 52 }, "color": { "description": "Canonical #RGB/#RRGGBB. Also accepts unprefixed 4/7 hex chars; strings of other lengths clear. Length 4/7 nonhex rejects. Not equivalent to strict CSS hex regex. Canonical representations are shown; other PHP scalar coercions are not presented as rejection constraints.\n\nfalse or string length other than 4/7 -> empty aP string. At length4/7, hexadecimal after ltrim(all leading #) is required; nonhex returns false. Empty output -> false.\n\nRuntime preconditions / rejection: Length4/7 nonhex text returns strict false -> ED80100.", "x-edoobox-canonicalType": "string or false", "x-edoobox-schemaStatus": "source-reviewed", "examples": [ "#a1b", false ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Design.php", "line": 65, "lineStart": 65, "lineEnd": 84, "sha256": "30fc7f721958cb19e4ae31703698687fff67518d807af84f591f3526d2ef3fd8", "spanSha256": "771000c8566835f13d6d1779f5f4cc536ea201dea6a35b330d16edcbcf6550a5", "reason": "Structure getter, output setter and field flags." }, { "file": "application/helpers/edooboxhelp_helper.php", "line": 11560, "lineStart": 11560, "lineEnd": 11606, "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e", "spanSha256": "2172cc49e4bcdb6840448b62929037cb9b90c299da3cb6fb0be6a8782881750f", "reason": "aP text normalization and aQ output. Reviewed aP update preserves legacy encoded storage and aQ read semantics. Truncation removes a dangling final escape backslash rather than creating a broken SQL literal; it remains normalization, not a rejecting raw input maxLength." }, { "file": "application/models/v2/Design.php", "line": 117, "lineStart": 117, "lineEnd": 139, "sha256": "30fc7f721958cb19e4ae31703698687fff67518d807af84f591f3526d2ef3fd8", "spanSha256": "e42660c8c4b9e9274c064605ffdad60d0943bf78a429ecde1334840e2696d01f", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "docs/openapi/reviews/domain-fields.json", "line": 1, "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.", "sha256": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667" } ] }, "booking_cart_enabled": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 85, "x-edoobox-canonicalType": "boolean", "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.", "examples": [ false ] }, "design": { "type": "string", "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.", "examples": [ "design_012345abcdef_123456" ] } }, "additionalProperties": true, "description": "Source-declared fields; action-specific and account validation still apply.", "required": [ "name", "design" ], "minProperties": 1 }, { "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "object", "properties": { "id": false, "bootstrap": { "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": [ "bootstrap_012345abcdef_123456" ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 39 }, "name": { "x-edoobox-canonicalType": "string", "x-edoobox-maxStoredLength": 200, "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.", "examples": [ "Example" ], "x-edoobox-requiredOnCreate": true, "x-edoobox-sourceLine": 52 }, "color": { "description": "Canonical #RGB/#RRGGBB. Also accepts unprefixed 4/7 hex chars; strings of other lengths clear. Length 4/7 nonhex rejects. Not equivalent to strict CSS hex regex. Canonical representations are shown; other PHP scalar coercions are not presented as rejection constraints.\n\nfalse or string length other than 4/7 -> empty aP string. At length4/7, hexadecimal after ltrim(all leading #) is required; nonhex returns false. Empty output -> false.\n\nRuntime preconditions / rejection: Length4/7 nonhex text returns strict false -> ED80100.", "x-edoobox-canonicalType": "string or false", "x-edoobox-schemaStatus": "source-reviewed", "examples": [ "#a1b", false ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Design.php", "line": 65, "lineStart": 65, "lineEnd": 84, "sha256": "30fc7f721958cb19e4ae31703698687fff67518d807af84f591f3526d2ef3fd8", "spanSha256": "771000c8566835f13d6d1779f5f4cc536ea201dea6a35b330d16edcbcf6550a5", "reason": "Structure getter, output setter and field flags." }, { "file": "application/helpers/edooboxhelp_helper.php", "line": 11560, "lineStart": 11560, "lineEnd": 11606, "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e", "spanSha256": "2172cc49e4bcdb6840448b62929037cb9b90c299da3cb6fb0be6a8782881750f", "reason": "aP text normalization and aQ output. Reviewed aP update preserves legacy encoded storage and aQ read semantics. Truncation removes a dangling final escape backslash rather than creating a broken SQL literal; it remains normalization, not a rejecting raw input maxLength." }, { "file": "application/models/v2/Design.php", "line": 117, "lineStart": 117, "lineEnd": 139, "sha256": "30fc7f721958cb19e4ae31703698687fff67518d807af84f591f3526d2ef3fd8", "spanSha256": "e42660c8c4b9e9274c064605ffdad60d0943bf78a429ecde1334840e2696d01f", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "docs/openapi/reviews/domain-fields.json", "line": 1, "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.", "sha256": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667" } ] }, "booking_cart_enabled": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 85, "x-edoobox-canonicalType": "boolean", "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.", "examples": [ false ] }, "design": { "type": "string", "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.", "examples": [ "design_012345abcdef_123456" ] } }, "additionalProperties": true, "description": "Source-declared fields; action-specific and account validation still apply.", "required": [ "name", "design" ] } } ], "x-edoobox-readOnlyFields": [], "x-edoobox-clientRestriction": "The server-generated id is forbidden. insert:false fields are readOnly and tolerated for existing Vue payloads because the API skips them." }, "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": [ "design_012345abcdef_123456" ] } }, "additionalProperties": true, "required": [ "data" ] }, "examples": { "request": { "summary": "Buchungsdesign anlegen", "value": { "data": { "name": "Sommerkurse", "design": "design_012345abcdef_123456", "booking_cart_enabled": true } } } } } } } ``` ## Antworten HTTP-Status und Antwortinhalt gemeinsam auswerten. Die folgenden Beschreibungen und Schemata sind die Angaben der Quelldatei. ```json { "200": { "description": "data enthält insert, öffentliche id und bei Uploads signierte upload_url; öffentliche Dateien liefern zusätzlich cdn_url. Bei fehlgeschlagenem Transaktionsabschluss enthält data insert=false und id=null; error ist ED80100.", "content": { "application/json": { "example": { "success": true, "error": false, "data": { "id": "design_012345abcdef_123456", "insert": true } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": [ "boolean", "string" ] }, "error_code": { "type": "string" }, "data": { "type": "object", "properties": { "insert": { "type": "boolean" }, "id": { "oneOf": [ { "type": "string", "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.", "examples": [ "design_012345abcdef_123456" ] }, { "type": "array", "items": { "type": "string", "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.", "examples": [ "design_012345abcdef_123456" ] } }, { "type": "null" } ], "description": "Bei erfolgreichem Einzelinsert öffentliche v2-ID, bei erfolgreichem Batch ein Array öffentlicher IDs; bei fehlgeschlagenem Transaktionsabschluss null zusammen mit insert=false und error=ED80100." } }, "additionalProperties": true, "required": [ "id", "insert" ] }, "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. # Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen. : "${API_ORIGIN:?API_ORIGIN setzen}" : "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}" : "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}" cat > payload.json <<'EDOOBOX_JSON_EXAMPLE' { "data": { "name": "Sommerkurse", "design": "design_012345abcdef_123456", "booking_cart_enabled": true } } EDOOBOX_JSON_EXAMPLE curl --request 'POST' \ --url "${API_ORIGIN%/}"'/v2/design' \ --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \ --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" \ --header 'Content-Type: application/json' \ --data-binary '@payload.json' ``` ### JavaScript (Node.js) ```javascript // Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich. // Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen. const required = (name) => { const value = process.env[name]; if (!value) throw new Error(`Set ${name}`); return value; }; let path = "/v2/design"; 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"); headers['Content-Type'] = "application/json"; const body = JSON.stringify({ "data": { "name": "Sommerkurse", "design": "design_012345abcdef_123456", "booking_cart_enabled": true } }); const response = await fetch(url, { method: "POST", headers, body, 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. # Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen. import os import urllib.parse import urllib.request import urllib.error path = "/v2/design" url = os.environ["API_ORIGIN"].rstrip("/") + path headers = {} headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"] headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"] headers["Content-Type"] = "application/json" body = "{\"data\":{\"name\":\"Sommerkurse\",\"design\":\"design_012345abcdef_123456\",\"booking_cart_enabled\":true}}".encode("utf-8") # 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="POST", data=body) 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": "post_v2_design", "summary": "Buchungsdesign anlegen", "description": "Erstellt ein Buchungsdesign durch Kopieren eines bestehenden eigenen oder öffentlichen Vorlage-Designs. Zusätzlich zu name ist data.design erforderlich. Widgets werden kopiert, fehlende Standard-Formularfelder ergänzt und das Buchungswarenkorb-Verhalten sowie Bootstrap bei fehlender expliziter Angabe übernommen. data akzeptiert einen Datensatz oder ein Array mit bis zu 100 Datensätzen; bei einem Batch enthält data.id ein Array öffentlicher IDs.", "tags": [ "design" ], "security": [ { "bearerAuth": [], "accountContext": [] }, { "sessionCookie": [], "accountContext": [] } ], "parameters": [ { "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": "data enthält insert, öffentliche id und bei Uploads signierte upload_url; öffentliche Dateien liefern zusätzlich cdn_url. Bei fehlgeschlagenem Transaktionsabschluss enthält data insert=false und id=null; error ist ED80100.", "content": { "application/json": { "example": { "success": true, "error": false, "data": { "id": "design_012345abcdef_123456", "insert": true } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": [ "boolean", "string" ] }, "error_code": { "type": "string" }, "data": { "type": "object", "properties": { "insert": { "type": "boolean" }, "id": { "oneOf": [ { "type": "string", "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.", "examples": [ "design_012345abcdef_123456" ] }, { "type": "array", "items": { "type": "string", "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.", "examples": [ "design_012345abcdef_123456" ] } }, { "type": "null" } ], "description": "Bei erfolgreichem Einzelinsert öffentliche v2-ID, bei erfolgreichem Batch ein Array öffentlicher IDs; bei fehlgeschlagenem Transaktionsabschluss null zusammen mit insert=false und error=ED80100." } }, "additionalProperties": true, "required": [ "id", "insert" ] }, "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": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "id": false, "bootstrap": { "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": [ "bootstrap_012345abcdef_123456" ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 39 }, "name": { "x-edoobox-canonicalType": "string", "x-edoobox-maxStoredLength": 200, "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.", "examples": [ "Example" ], "x-edoobox-requiredOnCreate": true, "x-edoobox-sourceLine": 52 }, "color": { "description": "Canonical #RGB/#RRGGBB. Also accepts unprefixed 4/7 hex chars; strings of other lengths clear. Length 4/7 nonhex rejects. Not equivalent to strict CSS hex regex. Canonical representations are shown; other PHP scalar coercions are not presented as rejection constraints.\n\nfalse or string length other than 4/7 -> empty aP string. At length4/7, hexadecimal after ltrim(all leading #) is required; nonhex returns false. Empty output -> false.\n\nRuntime preconditions / rejection: Length4/7 nonhex text returns strict false -> ED80100.", "x-edoobox-canonicalType": "string or false", "x-edoobox-schemaStatus": "source-reviewed", "examples": [ "#a1b", false ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Design.php", "line": 65, "lineStart": 65, "lineEnd": 84, "sha256": "30fc7f721958cb19e4ae31703698687fff67518d807af84f591f3526d2ef3fd8", "spanSha256": "771000c8566835f13d6d1779f5f4cc536ea201dea6a35b330d16edcbcf6550a5", "reason": "Structure getter, output setter and field flags." }, { "file": "application/helpers/edooboxhelp_helper.php", "line": 11560, "lineStart": 11560, "lineEnd": 11606, "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e", "spanSha256": "2172cc49e4bcdb6840448b62929037cb9b90c299da3cb6fb0be6a8782881750f", "reason": "aP text normalization and aQ output. Reviewed aP update preserves legacy encoded storage and aQ read semantics. Truncation removes a dangling final escape backslash rather than creating a broken SQL literal; it remains normalization, not a rejecting raw input maxLength." }, { "file": "application/models/v2/Design.php", "line": 117, "lineStart": 117, "lineEnd": 139, "sha256": "30fc7f721958cb19e4ae31703698687fff67518d807af84f591f3526d2ef3fd8", "spanSha256": "e42660c8c4b9e9274c064605ffdad60d0943bf78a429ecde1334840e2696d01f", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "docs/openapi/reviews/domain-fields.json", "line": 1, "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.", "sha256": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667" } ] }, "booking_cart_enabled": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 85, "x-edoobox-canonicalType": "boolean", "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.", "examples": [ false ] }, "design": { "type": "string", "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.", "examples": [ "design_012345abcdef_123456" ] } }, "additionalProperties": true, "description": "Source-declared fields; action-specific and account validation still apply.", "required": [ "name", "design" ], "minProperties": 1 }, { "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "object", "properties": { "id": false, "bootstrap": { "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": [ "bootstrap_012345abcdef_123456" ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 39 }, "name": { "x-edoobox-canonicalType": "string", "x-edoobox-maxStoredLength": 200, "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.", "examples": [ "Example" ], "x-edoobox-requiredOnCreate": true, "x-edoobox-sourceLine": 52 }, "color": { "description": "Canonical #RGB/#RRGGBB. Also accepts unprefixed 4/7 hex chars; strings of other lengths clear. Length 4/7 nonhex rejects. Not equivalent to strict CSS hex regex. Canonical representations are shown; other PHP scalar coercions are not presented as rejection constraints.\n\nfalse or string length other than 4/7 -> empty aP string. At length4/7, hexadecimal after ltrim(all leading #) is required; nonhex returns false. Empty output -> false.\n\nRuntime preconditions / rejection: Length4/7 nonhex text returns strict false -> ED80100.", "x-edoobox-canonicalType": "string or false", "x-edoobox-schemaStatus": "source-reviewed", "examples": [ "#a1b", false ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Design.php", "line": 65, "lineStart": 65, "lineEnd": 84, "sha256": "30fc7f721958cb19e4ae31703698687fff67518d807af84f591f3526d2ef3fd8", "spanSha256": "771000c8566835f13d6d1779f5f4cc536ea201dea6a35b330d16edcbcf6550a5", "reason": "Structure getter, output setter and field flags." }, { "file": "application/helpers/edooboxhelp_helper.php", "line": 11560, "lineStart": 11560, "lineEnd": 11606, "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e", "spanSha256": "2172cc49e4bcdb6840448b62929037cb9b90c299da3cb6fb0be6a8782881750f", "reason": "aP text normalization and aQ output. Reviewed aP update preserves legacy encoded storage and aQ read semantics. Truncation removes a dangling final escape backslash rather than creating a broken SQL literal; it remains normalization, not a rejecting raw input maxLength." }, { "file": "application/models/v2/Design.php", "line": 117, "lineStart": 117, "lineEnd": 139, "sha256": "30fc7f721958cb19e4ae31703698687fff67518d807af84f591f3526d2ef3fd8", "spanSha256": "e42660c8c4b9e9274c064605ffdad60d0943bf78a429ecde1334840e2696d01f", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "docs/openapi/reviews/domain-fields.json", "line": 1, "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.", "sha256": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667" } ] }, "booking_cart_enabled": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 85, "x-edoobox-canonicalType": "boolean", "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.", "examples": [ false ] }, "design": { "type": "string", "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.", "examples": [ "design_012345abcdef_123456" ] } }, "additionalProperties": true, "description": "Source-declared fields; action-specific and account validation still apply.", "required": [ "name", "design" ] } } ], "x-edoobox-readOnlyFields": [], "x-edoobox-clientRestriction": "The server-generated id is forbidden. insert:false fields are readOnly and tolerated for existing Vue payloads because the API skips them." }, "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": [ "design_012345abcdef_123456" ] } }, "additionalProperties": true, "required": [ "data" ] }, "examples": { "request": { "summary": "Buchungsdesign anlegen", "value": { "data": { "name": "Sommerkurse", "design": "design_012345abcdef_123456", "booking_cart_enabled": true } } } } } } }, "x-edoobox-runtimeMutationGuard": true, "x-edoobox-documentationReview": { "file": "docs/openapi/operation-contracts/07-layout-files.json", "notes": [] }, "x-edoobox-source": { "file": "application/models/v2/Design.php", "method": "postDesign", "line": 117 }, "x-edoobox-documentationStatus": "reviewed", "x-edoobox-readOnly": false, "x-edoobox-safeForAutomation": false, "x-edoobox-permission": { "resource": "design", "short": "desi", "checkedByDispatcher": true, "levels": [ 2, 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." } } ```