# POST /v2/category Kategorie anlegen Legt Kategorie mit data an. data kann ein Datensatz oder eine Liste von Datensätzen sein; die im Schema markierten Pflichtfelder gelten für jeden Datensatz. Beziehungen verwenden öffentliche v2-IDs. name darf zusätzlich als Liste von {language,value} übergeben werden; die Kontostandardsprache muss enthalten sein, weitere aktive Kontosprachen werden nachgetragen. Baum- und Abo-Regeln werden serverseitig geprüft. type muss eine Kategorie ergeben (folder bzw. normalisierte Standardangabe); über diesen Endpunkt entstehen keine Angebote oder Systemwurzeln. Der Parent muss eine zulässige Kategorie bzw. Wurzel mit konsistentem Archivstatus sein. - Operation-ID: post_v2_category - Dokumentation: /docs/api/v2/operations/post-v2-category-dfa13e5a7716/ - 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, "name": { "x-edoobox-canonicalType": "string", "x-edoobox-maxStoredLength": 80, "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-writableOnUpdate": false, "x-edoobox-requiredOnCreate": true, "x-edoobox-sourceLine": 30 }, "row_lft": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 58, "x-edoobox-canonicalType": "integer", "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.", "examples": [ 1 ] }, "row_rgt": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 68, "x-edoobox-canonicalType": "integer", "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.", "examples": [ 1 ] }, "order": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 78, "x-edoobox-canonicalType": "integer", "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.", "examples": [ 1 ] }, "image": { "not": {}, "description": "No supplied value is accepted here: getter returns strict false and generic API_DATA rejects ED80100. Omit server-maintained field.\n\nGetter always returns strict false, regardless of supplied value.\n\nRuntime preconditions / rejection: Every supplied value on generic POST (and generic PUT when update is allowed) causes ED80100 through API_DATA strict-false check.\n\nScope / limitations: Recommend response-only/readOnly, remove from generic write properties; separate actions can manage it through their own payload logic.", "x-edoobox-schemaStatus": "source-reviewed", "x-edoobox-contractSource": [ { "file": "application/models/v2/Category.php", "line": 95, "lineStart": 95, "lineEnd": 112, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "1232dab7d815f052901c5335ecf83df35dc6063e4fded1a864d8de16b8aee621", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Category.php", "line": 268, "lineStart": 268, "lineEnd": 303, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "3b64150dba0beb6abedf5061f2b9e11f36159e56028ca8e00171a15d93302784", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Category.php", "line": 373, "lineStart": 373, "lineEnd": 394, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "6ed1a2030b3f277a83ece5878a285d06b4a16597da58e1ae03fb27fe5f35f27c", "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": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db" } ] }, "category": { "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": [ "category_012345abcdef_123456" ], "x-edoobox-writableOnUpdate": false, "x-edoobox-requiredOnCreate": true, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 113 }, "type": { "x-edoobox-knownInputs": [ "offer", "folder", "archive", "trash" ], "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.", "examples": [ "offer" ], "x-edoobox-writableOnUpdate": false, "x-edoobox-requiredOnCreate": true, "x-edoobox-sourceLine": 133 }, "design": { "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": [ "design_012345abcdef_123456" ] }, { "const": false }, { "type": "null" } ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 172 }, "internal_code": { "x-edoobox-canonicalType": "string", "x-edoobox-maxStoredLength": 40, "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-sourceLine": 188 }, "prevent_multiple_bookings": { "x-edoobox-recognizedValues": [ "status", "gender", "first_name", "last_name", "street", "postcode", "location", "country", "language", "phone_number", "email", "company", "data_1", "data_2", "data_3", "data_4", "data_5", "data_6", "data_7", "data_8", "data_9", "data_10", "data_11", "data_12", "data_13", "data_14", "data_15", "data_16", "data_17", "data_18", "data_19", "data_20", "data_21", "data_22", "data_23", "data_24", "data_25", "data_26", "data_27", "data_28", "data_29", "data_30" ], "description": "false clears; recognized participant-data key maps to its DB column. Unknown string returns null rather than explicit rejection. Canonical representations are shown; other PHP scalar coercions are not presented as rejection constraints.\n\nFalsy input -> empty DB text. Known key -> Datastructure column. Unknown key falls through null. Empty output -> false; known column -> public key; unmapped nonempty -> null.", "x-edoobox-canonicalType": "string or false", "x-edoobox-schemaStatus": "source-reviewed", "examples": [ "email", false ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Category.php", "line": 198, "lineStart": 198, "lineEnd": 220, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "101039fe8703832f5080f0af566ed7113ce1b2584974b72c122f070794ea90c6", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Datastructure.php", "line": 20, "lineStart": 20, "lineEnd": 126, "sha256": "256cfd2c1002e4708b342b6649fa6bfda780273306c30ae2a43d424fd0e2e6a8", "spanSha256": "e0b745f0330dae128c01bcc320aa6dc4429d391260fee2e2d6964a611041e2a9", "reason": "Known participant keys plus data_1..data_30 generation and returnStructure." }, { "file": "application/models/v2/Category.php", "line": 268, "lineStart": 268, "lineEnd": 303, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "3b64150dba0beb6abedf5061f2b9e11f36159e56028ca8e00171a15d93302784", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Category.php", "line": 373, "lineStart": 373, "lineEnd": 394, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "6ed1a2030b3f277a83ece5878a285d06b4a16597da58e1ae03fb27fe5f35f27c", "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": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db" } ] }, "archive": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 221, "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 ] }, "trash": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 233, "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 ] } }, "additionalProperties": true, "description": "Source-declared fields; action-specific and account validation still apply.", "required": [ "name", "category", "type" ], "minProperties": 1 }, { "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "object", "properties": { "id": false, "name": { "x-edoobox-canonicalType": "string", "x-edoobox-maxStoredLength": 80, "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-writableOnUpdate": false, "x-edoobox-requiredOnCreate": true, "x-edoobox-sourceLine": 30 }, "row_lft": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 58, "x-edoobox-canonicalType": "integer", "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.", "examples": [ 1 ] }, "row_rgt": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 68, "x-edoobox-canonicalType": "integer", "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.", "examples": [ 1 ] }, "order": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 78, "x-edoobox-canonicalType": "integer", "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.", "examples": [ 1 ] }, "image": { "not": {}, "description": "No supplied value is accepted here: getter returns strict false and generic API_DATA rejects ED80100. Omit server-maintained field.\n\nGetter always returns strict false, regardless of supplied value.\n\nRuntime preconditions / rejection: Every supplied value on generic POST (and generic PUT when update is allowed) causes ED80100 through API_DATA strict-false check.\n\nScope / limitations: Recommend response-only/readOnly, remove from generic write properties; separate actions can manage it through their own payload logic.", "x-edoobox-schemaStatus": "source-reviewed", "x-edoobox-contractSource": [ { "file": "application/models/v2/Category.php", "line": 95, "lineStart": 95, "lineEnd": 112, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "1232dab7d815f052901c5335ecf83df35dc6063e4fded1a864d8de16b8aee621", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Category.php", "line": 268, "lineStart": 268, "lineEnd": 303, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "3b64150dba0beb6abedf5061f2b9e11f36159e56028ca8e00171a15d93302784", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Category.php", "line": 373, "lineStart": 373, "lineEnd": 394, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "6ed1a2030b3f277a83ece5878a285d06b4a16597da58e1ae03fb27fe5f35f27c", "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": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db" } ] }, "category": { "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": [ "category_012345abcdef_123456" ], "x-edoobox-writableOnUpdate": false, "x-edoobox-requiredOnCreate": true, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 113 }, "type": { "x-edoobox-knownInputs": [ "offer", "folder", "archive", "trash" ], "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.", "examples": [ "offer" ], "x-edoobox-writableOnUpdate": false, "x-edoobox-requiredOnCreate": true, "x-edoobox-sourceLine": 133 }, "design": { "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": [ "design_012345abcdef_123456" ] }, { "const": false }, { "type": "null" } ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 172 }, "internal_code": { "x-edoobox-canonicalType": "string", "x-edoobox-maxStoredLength": 40, "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-sourceLine": 188 }, "prevent_multiple_bookings": { "x-edoobox-recognizedValues": [ "status", "gender", "first_name", "last_name", "street", "postcode", "location", "country", "language", "phone_number", "email", "company", "data_1", "data_2", "data_3", "data_4", "data_5", "data_6", "data_7", "data_8", "data_9", "data_10", "data_11", "data_12", "data_13", "data_14", "data_15", "data_16", "data_17", "data_18", "data_19", "data_20", "data_21", "data_22", "data_23", "data_24", "data_25", "data_26", "data_27", "data_28", "data_29", "data_30" ], "description": "false clears; recognized participant-data key maps to its DB column. Unknown string returns null rather than explicit rejection. Canonical representations are shown; other PHP scalar coercions are not presented as rejection constraints.\n\nFalsy input -> empty DB text. Known key -> Datastructure column. Unknown key falls through null. Empty output -> false; known column -> public key; unmapped nonempty -> null.", "x-edoobox-canonicalType": "string or false", "x-edoobox-schemaStatus": "source-reviewed", "examples": [ "email", false ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Category.php", "line": 198, "lineStart": 198, "lineEnd": 220, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "101039fe8703832f5080f0af566ed7113ce1b2584974b72c122f070794ea90c6", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Datastructure.php", "line": 20, "lineStart": 20, "lineEnd": 126, "sha256": "256cfd2c1002e4708b342b6649fa6bfda780273306c30ae2a43d424fd0e2e6a8", "spanSha256": "e0b745f0330dae128c01bcc320aa6dc4429d391260fee2e2d6964a611041e2a9", "reason": "Known participant keys plus data_1..data_30 generation and returnStructure." }, { "file": "application/models/v2/Category.php", "line": 268, "lineStart": 268, "lineEnd": 303, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "3b64150dba0beb6abedf5061f2b9e11f36159e56028ca8e00171a15d93302784", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Category.php", "line": 373, "lineStart": 373, "lineEnd": 394, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "6ed1a2030b3f277a83ece5878a285d06b4a16597da58e1ae03fb27fe5f35f27c", "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": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db" } ] }, "archive": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 221, "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 ] }, "trash": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 233, "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 ] } }, "additionalProperties": true, "description": "Source-declared fields; action-specific and account validation still apply.", "required": [ "name", "category", "type" ] } } ], "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": [ "category_012345abcdef_123456" ] } }, "additionalProperties": true, "required": [ "data" ] }, "examples": { "command": { "summary": "Synthetic request envelope; use fields documented by the resource.", "value": { "data": { "name": "Example category", "category": "category_012345abcdef_123456", "type": "folder" } } } } } } } ``` ## Antworten HTTP-Status und Antwortinhalt gemeinsam auswerten. Die folgenden Beschreibungen und Schemata sind die Angaben der Quelldatei. ```json { "200": { "description": "Ergebnis in data mit den beschriebenen Feldern; error und die Ergebniskennzeichen müssen ausgewertet werden.", "content": { "application/json": { "example": { "success": true, "error": false, "data": { "id": "category_012345abcdef_123456", "insert": true } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": [ "boolean", "string" ] }, "error_code": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "pattern": "^category_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.", "examples": [ "category_012345abcdef_123456" ] }, { "type": "array", "items": { "type": "string", "pattern": "^category_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.", "examples": [ "category_012345abcdef_123456" ] } }, { "type": "null" } ] }, "insert": { "type": "boolean" } }, "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": "Example category", "category": "category_012345abcdef_123456", "type": "folder" } } EDOOBOX_JSON_EXAMPLE curl --request 'POST' \ --url "${API_ORIGIN%/}"'/v2/category' \ --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/category"; 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": "Example category", "category": "category_012345abcdef_123456", "type": "folder" } }); 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/category" 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\":\"Example category\",\"category\":\"category_012345abcdef_123456\",\"type\":\"folder\"}}".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_category", "summary": "Kategorie anlegen", "description": "Legt Kategorie mit data an. data kann ein Datensatz oder eine Liste von Datensätzen sein; die im Schema markierten Pflichtfelder gelten für jeden Datensatz. Beziehungen verwenden öffentliche v2-IDs. name darf zusätzlich als Liste von {language,value} übergeben werden; die Kontostandardsprache muss enthalten sein, weitere aktive Kontosprachen werden nachgetragen. Baum- und Abo-Regeln werden serverseitig geprüft. type muss eine Kategorie ergeben (folder bzw. normalisierte Standardangabe); über diesen Endpunkt entstehen keine Angebote oder Systemwurzeln. Der Parent muss eine zulässige Kategorie bzw. Wurzel mit konsistentem Archivstatus sein.", "tags": [ "category" ], "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": "Ergebnis in data mit den beschriebenen Feldern; error und die Ergebniskennzeichen müssen ausgewertet werden.", "content": { "application/json": { "example": { "success": true, "error": false, "data": { "id": "category_012345abcdef_123456", "insert": true } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": [ "boolean", "string" ] }, "error_code": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "pattern": "^category_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.", "examples": [ "category_012345abcdef_123456" ] }, { "type": "array", "items": { "type": "string", "pattern": "^category_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.", "examples": [ "category_012345abcdef_123456" ] } }, { "type": "null" } ] }, "insert": { "type": "boolean" } }, "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, "name": { "x-edoobox-canonicalType": "string", "x-edoobox-maxStoredLength": 80, "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-writableOnUpdate": false, "x-edoobox-requiredOnCreate": true, "x-edoobox-sourceLine": 30 }, "row_lft": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 58, "x-edoobox-canonicalType": "integer", "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.", "examples": [ 1 ] }, "row_rgt": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 68, "x-edoobox-canonicalType": "integer", "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.", "examples": [ 1 ] }, "order": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 78, "x-edoobox-canonicalType": "integer", "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.", "examples": [ 1 ] }, "image": { "not": {}, "description": "No supplied value is accepted here: getter returns strict false and generic API_DATA rejects ED80100. Omit server-maintained field.\n\nGetter always returns strict false, regardless of supplied value.\n\nRuntime preconditions / rejection: Every supplied value on generic POST (and generic PUT when update is allowed) causes ED80100 through API_DATA strict-false check.\n\nScope / limitations: Recommend response-only/readOnly, remove from generic write properties; separate actions can manage it through their own payload logic.", "x-edoobox-schemaStatus": "source-reviewed", "x-edoobox-contractSource": [ { "file": "application/models/v2/Category.php", "line": 95, "lineStart": 95, "lineEnd": 112, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "1232dab7d815f052901c5335ecf83df35dc6063e4fded1a864d8de16b8aee621", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Category.php", "line": 268, "lineStart": 268, "lineEnd": 303, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "3b64150dba0beb6abedf5061f2b9e11f36159e56028ca8e00171a15d93302784", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Category.php", "line": 373, "lineStart": 373, "lineEnd": 394, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "6ed1a2030b3f277a83ece5878a285d06b4a16597da58e1ae03fb27fe5f35f27c", "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": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db" } ] }, "category": { "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": [ "category_012345abcdef_123456" ], "x-edoobox-writableOnUpdate": false, "x-edoobox-requiredOnCreate": true, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 113 }, "type": { "x-edoobox-knownInputs": [ "offer", "folder", "archive", "trash" ], "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.", "examples": [ "offer" ], "x-edoobox-writableOnUpdate": false, "x-edoobox-requiredOnCreate": true, "x-edoobox-sourceLine": 133 }, "design": { "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": [ "design_012345abcdef_123456" ] }, { "const": false }, { "type": "null" } ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 172 }, "internal_code": { "x-edoobox-canonicalType": "string", "x-edoobox-maxStoredLength": 40, "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-sourceLine": 188 }, "prevent_multiple_bookings": { "x-edoobox-recognizedValues": [ "status", "gender", "first_name", "last_name", "street", "postcode", "location", "country", "language", "phone_number", "email", "company", "data_1", "data_2", "data_3", "data_4", "data_5", "data_6", "data_7", "data_8", "data_9", "data_10", "data_11", "data_12", "data_13", "data_14", "data_15", "data_16", "data_17", "data_18", "data_19", "data_20", "data_21", "data_22", "data_23", "data_24", "data_25", "data_26", "data_27", "data_28", "data_29", "data_30" ], "description": "false clears; recognized participant-data key maps to its DB column. Unknown string returns null rather than explicit rejection. Canonical representations are shown; other PHP scalar coercions are not presented as rejection constraints.\n\nFalsy input -> empty DB text. Known key -> Datastructure column. Unknown key falls through null. Empty output -> false; known column -> public key; unmapped nonempty -> null.", "x-edoobox-canonicalType": "string or false", "x-edoobox-schemaStatus": "source-reviewed", "examples": [ "email", false ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Category.php", "line": 198, "lineStart": 198, "lineEnd": 220, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "101039fe8703832f5080f0af566ed7113ce1b2584974b72c122f070794ea90c6", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Datastructure.php", "line": 20, "lineStart": 20, "lineEnd": 126, "sha256": "256cfd2c1002e4708b342b6649fa6bfda780273306c30ae2a43d424fd0e2e6a8", "spanSha256": "e0b745f0330dae128c01bcc320aa6dc4429d391260fee2e2d6964a611041e2a9", "reason": "Known participant keys plus data_1..data_30 generation and returnStructure." }, { "file": "application/models/v2/Category.php", "line": 268, "lineStart": 268, "lineEnd": 303, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "3b64150dba0beb6abedf5061f2b9e11f36159e56028ca8e00171a15d93302784", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Category.php", "line": 373, "lineStart": 373, "lineEnd": 394, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "6ed1a2030b3f277a83ece5878a285d06b4a16597da58e1ae03fb27fe5f35f27c", "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": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db" } ] }, "archive": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 221, "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 ] }, "trash": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 233, "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 ] } }, "additionalProperties": true, "description": "Source-declared fields; action-specific and account validation still apply.", "required": [ "name", "category", "type" ], "minProperties": 1 }, { "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "object", "properties": { "id": false, "name": { "x-edoobox-canonicalType": "string", "x-edoobox-maxStoredLength": 80, "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-writableOnUpdate": false, "x-edoobox-requiredOnCreate": true, "x-edoobox-sourceLine": 30 }, "row_lft": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 58, "x-edoobox-canonicalType": "integer", "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.", "examples": [ 1 ] }, "row_rgt": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 68, "x-edoobox-canonicalType": "integer", "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.", "examples": [ 1 ] }, "order": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 78, "x-edoobox-canonicalType": "integer", "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.", "examples": [ 1 ] }, "image": { "not": {}, "description": "No supplied value is accepted here: getter returns strict false and generic API_DATA rejects ED80100. Omit server-maintained field.\n\nGetter always returns strict false, regardless of supplied value.\n\nRuntime preconditions / rejection: Every supplied value on generic POST (and generic PUT when update is allowed) causes ED80100 through API_DATA strict-false check.\n\nScope / limitations: Recommend response-only/readOnly, remove from generic write properties; separate actions can manage it through their own payload logic.", "x-edoobox-schemaStatus": "source-reviewed", "x-edoobox-contractSource": [ { "file": "application/models/v2/Category.php", "line": 95, "lineStart": 95, "lineEnd": 112, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "1232dab7d815f052901c5335ecf83df35dc6063e4fded1a864d8de16b8aee621", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Category.php", "line": 268, "lineStart": 268, "lineEnd": 303, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "3b64150dba0beb6abedf5061f2b9e11f36159e56028ca8e00171a15d93302784", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Category.php", "line": 373, "lineStart": 373, "lineEnd": 394, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "6ed1a2030b3f277a83ece5878a285d06b4a16597da58e1ae03fb27fe5f35f27c", "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": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db" } ] }, "category": { "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": [ "category_012345abcdef_123456" ], "x-edoobox-writableOnUpdate": false, "x-edoobox-requiredOnCreate": true, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 113 }, "type": { "x-edoobox-knownInputs": [ "offer", "folder", "archive", "trash" ], "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.", "examples": [ "offer" ], "x-edoobox-writableOnUpdate": false, "x-edoobox-requiredOnCreate": true, "x-edoobox-sourceLine": 133 }, "design": { "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": [ "design_012345abcdef_123456" ] }, { "const": false }, { "type": "null" } ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 172 }, "internal_code": { "x-edoobox-canonicalType": "string", "x-edoobox-maxStoredLength": 40, "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-sourceLine": 188 }, "prevent_multiple_bookings": { "x-edoobox-recognizedValues": [ "status", "gender", "first_name", "last_name", "street", "postcode", "location", "country", "language", "phone_number", "email", "company", "data_1", "data_2", "data_3", "data_4", "data_5", "data_6", "data_7", "data_8", "data_9", "data_10", "data_11", "data_12", "data_13", "data_14", "data_15", "data_16", "data_17", "data_18", "data_19", "data_20", "data_21", "data_22", "data_23", "data_24", "data_25", "data_26", "data_27", "data_28", "data_29", "data_30" ], "description": "false clears; recognized participant-data key maps to its DB column. Unknown string returns null rather than explicit rejection. Canonical representations are shown; other PHP scalar coercions are not presented as rejection constraints.\n\nFalsy input -> empty DB text. Known key -> Datastructure column. Unknown key falls through null. Empty output -> false; known column -> public key; unmapped nonempty -> null.", "x-edoobox-canonicalType": "string or false", "x-edoobox-schemaStatus": "source-reviewed", "examples": [ "email", false ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Category.php", "line": 198, "lineStart": 198, "lineEnd": 220, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "101039fe8703832f5080f0af566ed7113ce1b2584974b72c122f070794ea90c6", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Datastructure.php", "line": 20, "lineStart": 20, "lineEnd": 126, "sha256": "256cfd2c1002e4708b342b6649fa6bfda780273306c30ae2a43d424fd0e2e6a8", "spanSha256": "e0b745f0330dae128c01bcc320aa6dc4429d391260fee2e2d6964a611041e2a9", "reason": "Known participant keys plus data_1..data_30 generation and returnStructure." }, { "file": "application/models/v2/Category.php", "line": 268, "lineStart": 268, "lineEnd": 303, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "3b64150dba0beb6abedf5061f2b9e11f36159e56028ca8e00171a15d93302784", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Category.php", "line": 373, "lineStart": 373, "lineEnd": 394, "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45", "spanSha256": "6ed1a2030b3f277a83ece5878a285d06b4a16597da58e1ae03fb27fe5f35f27c", "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": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db" } ] }, "archive": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 221, "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 ] }, "trash": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 233, "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 ] } }, "additionalProperties": true, "description": "Source-declared fields; action-specific and account validation still apply.", "required": [ "name", "category", "type" ] } } ], "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": [ "category_012345abcdef_123456" ] } }, "additionalProperties": true, "required": [ "data" ] }, "examples": { "command": { "summary": "Synthetic request envelope; use fields documented by the resource.", "value": { "data": { "name": "Example category", "category": "category_012345abcdef_123456", "type": "folder" } } } } } } }, "x-edoobox-runtimeMutationGuard": true, "x-edoobox-documentationReview": { "file": "docs/openapi/operation-contracts/03-offers-places.json", "notes": [] }, "x-edoobox-source": { "file": "application/models/v2/Category.php", "method": "postCategory", "line": 268 }, "x-edoobox-documentationStatus": "reviewed", "x-edoobox-readOnly": false, "x-edoobox-safeForAutomation": false, "x-edoobox-permission": { "resource": "category", "short": "ctgy", "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." } } ```