# POST /v2/offer Angebot anlegen Legt Angebot 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=offer legt ein Angebot unter einer aktiven Kategorie oder einem geeigneten Multi-Angebot an. Archiv und Papierkorb sind als Ziel unzulässig. - Operation-ID: post_v2_offer - Dokumentation: /docs/api/v2/operations/post-v2-offer-1826a986b190/ - 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": { "anyOf": [ { "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": 31 }, { "type": "array", "items": { "type": "object", "required": [ "language", "value" ], "properties": { "language": { "type": "string" }, "value": { "type": "string", "maxLength": 80 } }, "additionalProperties": true } } ], "description": "Offer::postOffer also accepts localized name entries, selecting the account default language." }, "number": { "x-edoobox-canonicalType": "string", "x-edoobox-maxStoredLength": 120, "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": 59 }, "row_lft": { "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 ] }, "row_rgt": { "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 ] }, "user_maximum": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 88, "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": 104, "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 ] }, "user_minimal": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 122, "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 ] }, "date_start": { "x-edoobox-canonicalType": "string", "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.", "examples": [ "2026-10-15T10:00:00+02:00" ], "x-edoobox-writableOnUpdate": false, "x-edoobox-sourceLine": 137 }, "date_end": { "x-edoobox-canonicalType": "string", "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.", "examples": [ "2026-10-15T10:00:00+02:00" ], "x-edoobox-writableOnUpdate": false, "x-edoobox-sourceLine": 147 }, "date_close": { "x-edoobox-canonicalType": "string", "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.", "examples": [ "2026-10-15T10:00:00+02:00" ], "x-edoobox-sourceLine": 157 }, "date_displayend_reference": { "x-edoobox-knownInputs": [ "date_start", "date_end", "date_close" ], "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.", "examples": [ "date_start" ], "x-edoobox-sourceLine": 176, "description": "'date_open' => array(\n'db' => $this->tableS.'anmeldeschluss',\n'get' => function ($a, $fid, $insert = false) {\nreturn dP($a);\n},\n'set' => function ($a) {\nreturn dQ($a);\n},\n)," }, "date_displayend": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 203, "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 ] }, "date_displaystart": { "x-edoobox-canonicalType": "string", "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.", "examples": [ "2026-10-15T10:00:00+02:00" ], "x-edoobox-sourceLine": 218 }, "date_signupstart": { "x-edoobox-canonicalType": "string", "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.", "examples": [ "2026-10-15T10:00:00+02:00" ], "x-edoobox-sourceLine": 227 }, "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/Offer.php", "line": 238, "lineStart": 238, "lineEnd": 255, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "0910fe4d4b73261614b59c8bbd239974b4452748f0ecac01e90484f4471bcf8d", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Offer.php", "line": 681, "lineStart": 681, "lineEnd": 705, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "226a81690573780762b7f4f9d79c4b4e00cd8c6e0b85d3a51ca5600c85b98e05", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Offer.php", "line": 734, "lineStart": 734, "lineEnd": 735, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "3df2a38722a4fef1389fcc1049532ef37f0e37cfea45b5e550c72e79d46687ae", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Offer.php", "line": 805, "lineStart": 805, "lineEnd": 843, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "68bdbbf1d36aa5a89930b605bcdd68e1dd4dee314cba249bde700958ee6b6ae7", "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" } ] }, "place": { "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": [ "place_012345abcdef_123456" ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 256 }, "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": 269 }, "offerdef": { "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": [ "offerdef_012345abcdef_123456" ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 293 }, "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": 308 }, "mode": { "enum": [ "Online", "Onsite", "Blended" ], "x-edoobox-sourceLine": 347 }, "status": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 365, "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 ] }, "archive": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 380, "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": 392, "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 ] }, "waiting_list": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 404, "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 ] }, "mustpay": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 413, "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 ] }, "countdown": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 422, "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 ] }, "lesson_booking": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 437, "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 ] }, "multiple_registration": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 449, "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 ] }, "multiple_registration_type": { "x-edoobox-knownInputs": [ "named_users", "participant_count", "named_users_contact" ], "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.", "examples": [ "named_users" ], "x-edoobox-sourceLine": 459 }, "barcode_ticket": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 486, "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": "^[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" ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 495 }, "multi_offer": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 508, "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 ] }, "multi_offer_child": { "readOnly": true, "description": "Getter returns null without reading input. Before-insert derives child-parent relation from validated category/parent (kat_id) and overwrites it for multi-offer children. ", "x-edoobox-schemaStatus": "source-reviewed-not-writable", "x-edoobox-clientRestriction": "Omit server-generated or unsupported input fields; runtime behavior is described separately.", "x-edoobox-ignoredInput": true, "x-edoobox-contractSource": [ { "file": "application/models/v2/Offer.php", "line": 519, "lineStart": 519, "lineEnd": 531, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "f650845f3d4ac52e175c569575d10fb6316589d16d687a37890e060fe7c41384", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Offerfunc.php", "line": 1901, "lineStart": 1901, "lineEnd": 1980, "sha256": "0efa50df0d95a6e96901b30e045e68b43f00529f73fcccaf864d23d02c27e63d", "spanSha256": "d5dbd63221aa637fb979245ed9ecd7be3623ba73b35db42c3a96257be12741d5", "reason": "Locked parent/lifecycle checks and assignment from kat_id." }, { "file": "application/models/v2/Offer.php", "line": 681, "lineStart": 681, "lineEnd": 705, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "226a81690573780762b7f4f9d79c4b4e00cd8c6e0b85d3a51ca5600c85b98e05", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Offer.php", "line": 734, "lineStart": 734, "lineEnd": 735, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "3df2a38722a4fef1389fcc1049532ef37f0e37cfea45b5e550c72e79d46687ae", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Offer.php", "line": 805, "lineStart": 805, "lineEnd": 843, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "68bdbbf1d36aa5a89930b605bcdd68e1dd4dee314cba249bde700958ee6b6ae7", "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" } ] }, "vat": { "anyOf": [ { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." }, { "const": "dynamic" } ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Offer.php", "line": 534, "reason": "Input accepts the dynamic sentinel before decoding a vat ID.", "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5" }, { "file": "application/models/v2/Offer.php", "line": 540, "reason": "Response returns false, dynamic or a public vat ID.", "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5" } ] }, "cancellation_condition_group": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account.", "x-edoobox-contractSource": [ { "file": "application/models/v2/Offer.php", "line": 552, "reason": "Write decodes a public cancellationconditiongroup ID and rejects nonpositive results.", "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5" }, { "file": "application/models/v2/Offer.php", "line": 559, "reason": "Response uses integer zero when no group is assigned.", "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5" } ] }, "country": { "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": [ "country_012345abcdef_123456" ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 566 }, "shortdescription": { "x-edoobox-canonicalType": "string", "x-edoobox-maxStoredLength": 250, "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-sourceLine": 579 }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag": { "type": "string", "pattern": "^tag_[a-f0-9]{12}_-?[0-9]+$", "description": "Public tag v2 ID returned for a currently existing record in the selected account; signature, resource type and account ownership are checked by the native hook." }, "type": { "type": "string", "enum": [ "normal", "include", "exclude" ] } }, "additionalProperties": true, "required": [ "tag", "type" ] }, "description": "Replaces normal/include/exclude tag associations. Every supplied tag must be a typed, existing same-account tag and every mode must be recognized before relation writes. Duplicate associations are normalized.", "x-edoobox-contractSource": [ { "file": "application/models/v2/Offerfunc.php", "line": 2534, "reason": "Callback consumes an array of {tag,type} records instead of the aP get placeholder.", "sha256": "0efa50df0d95a6e96901b30e045e68b43f00529f73fcccaf864d23d02c27e63d" }, { "file": "application/models/v2/Offer.php", "line": 605, "reason": "Response builds an array of tag/type objects, not a scalar encoded ID.", "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5" }, { "file": "application/models/v2/Offerfunc.php", "line": 2557, "lineEnd": 2578, "sha256": "0efa50df0d95a6e96901b30e045e68b43f00529f73fcccaf864d23d02c27e63d", "reason": "All supplied tag IDs/types and the complete same-account tag existence set are validated before offer tag relation writes; unknown modes are rejected." } ] }, "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": 640 } }, "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": { "anyOf": [ { "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": 31 }, { "type": "array", "items": { "type": "object", "required": [ "language", "value" ], "properties": { "language": { "type": "string" }, "value": { "type": "string", "maxLength": 80 } }, "additionalProperties": true } } ], "description": "Offer::postOffer also accepts localized name entries, selecting the account default language." }, "number": { "x-edoobox-canonicalType": "string", "x-edoobox-maxStoredLength": 120, "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": 59 }, "row_lft": { "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 ] }, "row_rgt": { "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 ] }, "user_maximum": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 88, "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": 104, "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 ] }, "user_minimal": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 122, "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 ] }, "date_start": { "x-edoobox-canonicalType": "string", "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.", "examples": [ "2026-10-15T10:00:00+02:00" ], "x-edoobox-writableOnUpdate": false, "x-edoobox-sourceLine": 137 }, "date_end": { "x-edoobox-canonicalType": "string", "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.", "examples": [ "2026-10-15T10:00:00+02:00" ], "x-edoobox-writableOnUpdate": false, "x-edoobox-sourceLine": 147 }, "date_close": { "x-edoobox-canonicalType": "string", "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.", "examples": [ "2026-10-15T10:00:00+02:00" ], "x-edoobox-sourceLine": 157 }, "date_displayend_reference": { "x-edoobox-knownInputs": [ "date_start", "date_end", "date_close" ], "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.", "examples": [ "date_start" ], "x-edoobox-sourceLine": 176, "description": "'date_open' => array(\n'db' => $this->tableS.'anmeldeschluss',\n'get' => function ($a, $fid, $insert = false) {\nreturn dP($a);\n},\n'set' => function ($a) {\nreturn dQ($a);\n},\n)," }, "date_displayend": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 203, "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 ] }, "date_displaystart": { "x-edoobox-canonicalType": "string", "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.", "examples": [ "2026-10-15T10:00:00+02:00" ], "x-edoobox-sourceLine": 218 }, "date_signupstart": { "x-edoobox-canonicalType": "string", "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.", "examples": [ "2026-10-15T10:00:00+02:00" ], "x-edoobox-sourceLine": 227 }, "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/Offer.php", "line": 238, "lineStart": 238, "lineEnd": 255, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "0910fe4d4b73261614b59c8bbd239974b4452748f0ecac01e90484f4471bcf8d", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Offer.php", "line": 681, "lineStart": 681, "lineEnd": 705, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "226a81690573780762b7f4f9d79c4b4e00cd8c6e0b85d3a51ca5600c85b98e05", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Offer.php", "line": 734, "lineStart": 734, "lineEnd": 735, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "3df2a38722a4fef1389fcc1049532ef37f0e37cfea45b5e550c72e79d46687ae", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Offer.php", "line": 805, "lineStart": 805, "lineEnd": 843, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "68bdbbf1d36aa5a89930b605bcdd68e1dd4dee314cba249bde700958ee6b6ae7", "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" } ] }, "place": { "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": [ "place_012345abcdef_123456" ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 256 }, "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": 269 }, "offerdef": { "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": [ "offerdef_012345abcdef_123456" ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 293 }, "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": 308 }, "mode": { "enum": [ "Online", "Onsite", "Blended" ], "x-edoobox-sourceLine": 347 }, "status": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 365, "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 ] }, "archive": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 380, "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": 392, "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 ] }, "waiting_list": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 404, "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 ] }, "mustpay": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 413, "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 ] }, "countdown": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 422, "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 ] }, "lesson_booking": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 437, "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 ] }, "multiple_registration": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 449, "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 ] }, "multiple_registration_type": { "x-edoobox-knownInputs": [ "named_users", "participant_count", "named_users_contact" ], "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.", "examples": [ "named_users" ], "x-edoobox-sourceLine": 459 }, "barcode_ticket": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 486, "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": "^[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" ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 495 }, "multi_offer": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 508, "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 ] }, "multi_offer_child": { "readOnly": true, "description": "Getter returns null without reading input. Before-insert derives child-parent relation from validated category/parent (kat_id) and overwrites it for multi-offer children. ", "x-edoobox-schemaStatus": "source-reviewed-not-writable", "x-edoobox-clientRestriction": "Omit server-generated or unsupported input fields; runtime behavior is described separately.", "x-edoobox-ignoredInput": true, "x-edoobox-contractSource": [ { "file": "application/models/v2/Offer.php", "line": 519, "lineStart": 519, "lineEnd": 531, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "f650845f3d4ac52e175c569575d10fb6316589d16d687a37890e060fe7c41384", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Offerfunc.php", "line": 1901, "lineStart": 1901, "lineEnd": 1980, "sha256": "0efa50df0d95a6e96901b30e045e68b43f00529f73fcccaf864d23d02c27e63d", "spanSha256": "d5dbd63221aa637fb979245ed9ecd7be3623ba73b35db42c3a96257be12741d5", "reason": "Locked parent/lifecycle checks and assignment from kat_id." }, { "file": "application/models/v2/Offer.php", "line": 681, "lineStart": 681, "lineEnd": 705, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "226a81690573780762b7f4f9d79c4b4e00cd8c6e0b85d3a51ca5600c85b98e05", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Offer.php", "line": 734, "lineStart": 734, "lineEnd": 735, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "3df2a38722a4fef1389fcc1049532ef37f0e37cfea45b5e550c72e79d46687ae", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Offer.php", "line": 805, "lineStart": 805, "lineEnd": 843, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "68bdbbf1d36aa5a89930b605bcdd68e1dd4dee314cba249bde700958ee6b6ae7", "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" } ] }, "vat": { "anyOf": [ { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." }, { "const": "dynamic" } ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Offer.php", "line": 534, "reason": "Input accepts the dynamic sentinel before decoding a vat ID.", "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5" }, { "file": "application/models/v2/Offer.php", "line": 540, "reason": "Response returns false, dynamic or a public vat ID.", "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5" } ] }, "cancellation_condition_group": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account.", "x-edoobox-contractSource": [ { "file": "application/models/v2/Offer.php", "line": 552, "reason": "Write decodes a public cancellationconditiongroup ID and rejects nonpositive results.", "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5" }, { "file": "application/models/v2/Offer.php", "line": 559, "reason": "Response uses integer zero when no group is assigned.", "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5" } ] }, "country": { "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": [ "country_012345abcdef_123456" ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 566 }, "shortdescription": { "x-edoobox-canonicalType": "string", "x-edoobox-maxStoredLength": 250, "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-sourceLine": 579 }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag": { "type": "string", "pattern": "^tag_[a-f0-9]{12}_-?[0-9]+$", "description": "Public tag v2 ID returned for a currently existing record in the selected account; signature, resource type and account ownership are checked by the native hook." }, "type": { "type": "string", "enum": [ "normal", "include", "exclude" ] } }, "additionalProperties": true, "required": [ "tag", "type" ] }, "description": "Replaces normal/include/exclude tag associations. Every supplied tag must be a typed, existing same-account tag and every mode must be recognized before relation writes. Duplicate associations are normalized.", "x-edoobox-contractSource": [ { "file": "application/models/v2/Offerfunc.php", "line": 2534, "reason": "Callback consumes an array of {tag,type} records instead of the aP get placeholder.", "sha256": "0efa50df0d95a6e96901b30e045e68b43f00529f73fcccaf864d23d02c27e63d" }, { "file": "application/models/v2/Offer.php", "line": 605, "reason": "Response builds an array of tag/type objects, not a scalar encoded ID.", "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5" }, { "file": "application/models/v2/Offerfunc.php", "line": 2557, "lineEnd": 2578, "sha256": "0efa50df0d95a6e96901b30e045e68b43f00529f73fcccaf864d23d02c27e63d", "reason": "All supplied tag IDs/types and the complete same-account tag existence set are validated before offer tag relation writes; unknown modes are rejected." } ] }, "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": 640 } }, "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": [ "offer_012345abcdef_123456" ] } }, "additionalProperties": true, "required": [ "data" ] }, "examples": { "command": { "summary": "Synthetic request envelope; use fields documented by the resource.", "value": { "data": { "name": "Example offer", "category": "category_012345abcdef_123456", "type": "offer" } } } } } } } ``` ## 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": "offer_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": "^offer_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.", "examples": [ "offer_012345abcdef_123456" ] }, { "type": "array", "items": { "type": "string", "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.", "examples": [ "offer_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 offer", "category": "category_012345abcdef_123456", "type": "offer" } } EDOOBOX_JSON_EXAMPLE curl --request 'POST' \ --url "${API_ORIGIN%/}"'/v2/offer' \ --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/offer"; 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 offer", "category": "category_012345abcdef_123456", "type": "offer" } }); 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/offer" 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 offer\",\"category\":\"category_012345abcdef_123456\",\"type\":\"offer\"}}".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_offer", "summary": "Angebot anlegen", "description": "Legt Angebot 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=offer legt ein Angebot unter einer aktiven Kategorie oder einem geeigneten Multi-Angebot an. Archiv und Papierkorb sind als Ziel unzulässig.", "tags": [ "offer" ], "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": "offer_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": "^offer_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.", "examples": [ "offer_012345abcdef_123456" ] }, { "type": "array", "items": { "type": "string", "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.", "examples": [ "offer_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": { "anyOf": [ { "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": 31 }, { "type": "array", "items": { "type": "object", "required": [ "language", "value" ], "properties": { "language": { "type": "string" }, "value": { "type": "string", "maxLength": 80 } }, "additionalProperties": true } } ], "description": "Offer::postOffer also accepts localized name entries, selecting the account default language." }, "number": { "x-edoobox-canonicalType": "string", "x-edoobox-maxStoredLength": 120, "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": 59 }, "row_lft": { "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 ] }, "row_rgt": { "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 ] }, "user_maximum": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 88, "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": 104, "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 ] }, "user_minimal": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 122, "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 ] }, "date_start": { "x-edoobox-canonicalType": "string", "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.", "examples": [ "2026-10-15T10:00:00+02:00" ], "x-edoobox-writableOnUpdate": false, "x-edoobox-sourceLine": 137 }, "date_end": { "x-edoobox-canonicalType": "string", "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.", "examples": [ "2026-10-15T10:00:00+02:00" ], "x-edoobox-writableOnUpdate": false, "x-edoobox-sourceLine": 147 }, "date_close": { "x-edoobox-canonicalType": "string", "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.", "examples": [ "2026-10-15T10:00:00+02:00" ], "x-edoobox-sourceLine": 157 }, "date_displayend_reference": { "x-edoobox-knownInputs": [ "date_start", "date_end", "date_close" ], "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.", "examples": [ "date_start" ], "x-edoobox-sourceLine": 176, "description": "'date_open' => array(\n'db' => $this->tableS.'anmeldeschluss',\n'get' => function ($a, $fid, $insert = false) {\nreturn dP($a);\n},\n'set' => function ($a) {\nreturn dQ($a);\n},\n)," }, "date_displayend": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 203, "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 ] }, "date_displaystart": { "x-edoobox-canonicalType": "string", "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.", "examples": [ "2026-10-15T10:00:00+02:00" ], "x-edoobox-sourceLine": 218 }, "date_signupstart": { "x-edoobox-canonicalType": "string", "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.", "examples": [ "2026-10-15T10:00:00+02:00" ], "x-edoobox-sourceLine": 227 }, "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/Offer.php", "line": 238, "lineStart": 238, "lineEnd": 255, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "0910fe4d4b73261614b59c8bbd239974b4452748f0ecac01e90484f4471bcf8d", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Offer.php", "line": 681, "lineStart": 681, "lineEnd": 705, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "226a81690573780762b7f4f9d79c4b4e00cd8c6e0b85d3a51ca5600c85b98e05", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Offer.php", "line": 734, "lineStart": 734, "lineEnd": 735, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "3df2a38722a4fef1389fcc1049532ef37f0e37cfea45b5e550c72e79d46687ae", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Offer.php", "line": 805, "lineStart": 805, "lineEnd": 843, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "68bdbbf1d36aa5a89930b605bcdd68e1dd4dee314cba249bde700958ee6b6ae7", "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" } ] }, "place": { "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": [ "place_012345abcdef_123456" ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 256 }, "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": 269 }, "offerdef": { "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": [ "offerdef_012345abcdef_123456" ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 293 }, "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": 308 }, "mode": { "enum": [ "Online", "Onsite", "Blended" ], "x-edoobox-sourceLine": 347 }, "status": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 365, "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 ] }, "archive": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 380, "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": 392, "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 ] }, "waiting_list": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 404, "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 ] }, "mustpay": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 413, "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 ] }, "countdown": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 422, "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 ] }, "lesson_booking": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 437, "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 ] }, "multiple_registration": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 449, "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 ] }, "multiple_registration_type": { "x-edoobox-knownInputs": [ "named_users", "participant_count", "named_users_contact" ], "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.", "examples": [ "named_users" ], "x-edoobox-sourceLine": 459 }, "barcode_ticket": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 486, "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": "^[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" ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 495 }, "multi_offer": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 508, "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 ] }, "multi_offer_child": { "readOnly": true, "description": "Getter returns null without reading input. Before-insert derives child-parent relation from validated category/parent (kat_id) and overwrites it for multi-offer children. ", "x-edoobox-schemaStatus": "source-reviewed-not-writable", "x-edoobox-clientRestriction": "Omit server-generated or unsupported input fields; runtime behavior is described separately.", "x-edoobox-ignoredInput": true, "x-edoobox-contractSource": [ { "file": "application/models/v2/Offer.php", "line": 519, "lineStart": 519, "lineEnd": 531, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "f650845f3d4ac52e175c569575d10fb6316589d16d687a37890e060fe7c41384", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Offerfunc.php", "line": 1901, "lineStart": 1901, "lineEnd": 1980, "sha256": "0efa50df0d95a6e96901b30e045e68b43f00529f73fcccaf864d23d02c27e63d", "spanSha256": "d5dbd63221aa637fb979245ed9ecd7be3623ba73b35db42c3a96257be12741d5", "reason": "Locked parent/lifecycle checks and assignment from kat_id." }, { "file": "application/models/v2/Offer.php", "line": 681, "lineStart": 681, "lineEnd": 705, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "226a81690573780762b7f4f9d79c4b4e00cd8c6e0b85d3a51ca5600c85b98e05", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Offer.php", "line": 734, "lineStart": 734, "lineEnd": 735, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "3df2a38722a4fef1389fcc1049532ef37f0e37cfea45b5e550c72e79d46687ae", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Offer.php", "line": 805, "lineStart": 805, "lineEnd": 843, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "68bdbbf1d36aa5a89930b605bcdd68e1dd4dee314cba249bde700958ee6b6ae7", "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" } ] }, "vat": { "anyOf": [ { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." }, { "const": "dynamic" } ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Offer.php", "line": 534, "reason": "Input accepts the dynamic sentinel before decoding a vat ID.", "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5" }, { "file": "application/models/v2/Offer.php", "line": 540, "reason": "Response returns false, dynamic or a public vat ID.", "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5" } ] }, "cancellation_condition_group": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account.", "x-edoobox-contractSource": [ { "file": "application/models/v2/Offer.php", "line": 552, "reason": "Write decodes a public cancellationconditiongroup ID and rejects nonpositive results.", "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5" }, { "file": "application/models/v2/Offer.php", "line": 559, "reason": "Response uses integer zero when no group is assigned.", "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5" } ] }, "country": { "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": [ "country_012345abcdef_123456" ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 566 }, "shortdescription": { "x-edoobox-canonicalType": "string", "x-edoobox-maxStoredLength": 250, "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-sourceLine": 579 }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag": { "type": "string", "pattern": "^tag_[a-f0-9]{12}_-?[0-9]+$", "description": "Public tag v2 ID returned for a currently existing record in the selected account; signature, resource type and account ownership are checked by the native hook." }, "type": { "type": "string", "enum": [ "normal", "include", "exclude" ] } }, "additionalProperties": true, "required": [ "tag", "type" ] }, "description": "Replaces normal/include/exclude tag associations. Every supplied tag must be a typed, existing same-account tag and every mode must be recognized before relation writes. Duplicate associations are normalized.", "x-edoobox-contractSource": [ { "file": "application/models/v2/Offerfunc.php", "line": 2534, "reason": "Callback consumes an array of {tag,type} records instead of the aP get placeholder.", "sha256": "0efa50df0d95a6e96901b30e045e68b43f00529f73fcccaf864d23d02c27e63d" }, { "file": "application/models/v2/Offer.php", "line": 605, "reason": "Response builds an array of tag/type objects, not a scalar encoded ID.", "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5" }, { "file": "application/models/v2/Offerfunc.php", "line": 2557, "lineEnd": 2578, "sha256": "0efa50df0d95a6e96901b30e045e68b43f00529f73fcccaf864d23d02c27e63d", "reason": "All supplied tag IDs/types and the complete same-account tag existence set are validated before offer tag relation writes; unknown modes are rejected." } ] }, "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": 640 } }, "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": { "anyOf": [ { "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": 31 }, { "type": "array", "items": { "type": "object", "required": [ "language", "value" ], "properties": { "language": { "type": "string" }, "value": { "type": "string", "maxLength": 80 } }, "additionalProperties": true } } ], "description": "Offer::postOffer also accepts localized name entries, selecting the account default language." }, "number": { "x-edoobox-canonicalType": "string", "x-edoobox-maxStoredLength": 120, "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": 59 }, "row_lft": { "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 ] }, "row_rgt": { "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 ] }, "user_maximum": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 88, "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": 104, "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 ] }, "user_minimal": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 122, "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 ] }, "date_start": { "x-edoobox-canonicalType": "string", "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.", "examples": [ "2026-10-15T10:00:00+02:00" ], "x-edoobox-writableOnUpdate": false, "x-edoobox-sourceLine": 137 }, "date_end": { "x-edoobox-canonicalType": "string", "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.", "examples": [ "2026-10-15T10:00:00+02:00" ], "x-edoobox-writableOnUpdate": false, "x-edoobox-sourceLine": 147 }, "date_close": { "x-edoobox-canonicalType": "string", "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.", "examples": [ "2026-10-15T10:00:00+02:00" ], "x-edoobox-sourceLine": 157 }, "date_displayend_reference": { "x-edoobox-knownInputs": [ "date_start", "date_end", "date_close" ], "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.", "examples": [ "date_start" ], "x-edoobox-sourceLine": 176, "description": "'date_open' => array(\n'db' => $this->tableS.'anmeldeschluss',\n'get' => function ($a, $fid, $insert = false) {\nreturn dP($a);\n},\n'set' => function ($a) {\nreturn dQ($a);\n},\n)," }, "date_displayend": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 203, "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 ] }, "date_displaystart": { "x-edoobox-canonicalType": "string", "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.", "examples": [ "2026-10-15T10:00:00+02:00" ], "x-edoobox-sourceLine": 218 }, "date_signupstart": { "x-edoobox-canonicalType": "string", "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.", "examples": [ "2026-10-15T10:00:00+02:00" ], "x-edoobox-sourceLine": 227 }, "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/Offer.php", "line": 238, "lineStart": 238, "lineEnd": 255, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "0910fe4d4b73261614b59c8bbd239974b4452748f0ecac01e90484f4471bcf8d", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Offer.php", "line": 681, "lineStart": 681, "lineEnd": 705, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "226a81690573780762b7f4f9d79c4b4e00cd8c6e0b85d3a51ca5600c85b98e05", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Offer.php", "line": 734, "lineStart": 734, "lineEnd": 735, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "3df2a38722a4fef1389fcc1049532ef37f0e37cfea45b5e550c72e79d46687ae", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Offer.php", "line": 805, "lineStart": 805, "lineEnd": 843, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "68bdbbf1d36aa5a89930b605bcdd68e1dd4dee314cba249bde700958ee6b6ae7", "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" } ] }, "place": { "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": [ "place_012345abcdef_123456" ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 256 }, "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": 269 }, "offerdef": { "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": [ "offerdef_012345abcdef_123456" ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 293 }, "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": 308 }, "mode": { "enum": [ "Online", "Onsite", "Blended" ], "x-edoobox-sourceLine": 347 }, "status": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 365, "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 ] }, "archive": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 380, "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": 392, "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 ] }, "waiting_list": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 404, "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 ] }, "mustpay": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 413, "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 ] }, "countdown": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 422, "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 ] }, "lesson_booking": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 437, "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 ] }, "multiple_registration": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 449, "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 ] }, "multiple_registration_type": { "x-edoobox-knownInputs": [ "named_users", "participant_count", "named_users_contact" ], "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.", "examples": [ "named_users" ], "x-edoobox-sourceLine": 459 }, "barcode_ticket": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 486, "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": "^[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" ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 495 }, "multi_offer": { "x-edoobox-writableOnUpdate": false, "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 508, "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 ] }, "multi_offer_child": { "readOnly": true, "description": "Getter returns null without reading input. Before-insert derives child-parent relation from validated category/parent (kat_id) and overwrites it for multi-offer children. ", "x-edoobox-schemaStatus": "source-reviewed-not-writable", "x-edoobox-clientRestriction": "Omit server-generated or unsupported input fields; runtime behavior is described separately.", "x-edoobox-ignoredInput": true, "x-edoobox-contractSource": [ { "file": "application/models/v2/Offer.php", "line": 519, "lineStart": 519, "lineEnd": 531, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "f650845f3d4ac52e175c569575d10fb6316589d16d687a37890e060fe7c41384", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Offerfunc.php", "line": 1901, "lineStart": 1901, "lineEnd": 1980, "sha256": "0efa50df0d95a6e96901b30e045e68b43f00529f73fcccaf864d23d02c27e63d", "spanSha256": "d5dbd63221aa637fb979245ed9ecd7be3623ba73b35db42c3a96257be12741d5", "reason": "Locked parent/lifecycle checks and assignment from kat_id." }, { "file": "application/models/v2/Offer.php", "line": 681, "lineStart": 681, "lineEnd": 705, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "226a81690573780762b7f4f9d79c4b4e00cd8c6e0b85d3a51ca5600c85b98e05", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Offer.php", "line": 734, "lineStart": 734, "lineEnd": 735, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "3df2a38722a4fef1389fcc1049532ef37f0e37cfea45b5e550c72e79d46687ae", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "application/models/v2/Offer.php", "line": 805, "lineStart": 805, "lineEnd": 843, "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5", "spanSha256": "68bdbbf1d36aa5a89930b605bcdd68e1dd4dee314cba249bde700958ee6b6ae7", "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" } ] }, "vat": { "anyOf": [ { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." }, { "const": "dynamic" } ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Offer.php", "line": 534, "reason": "Input accepts the dynamic sentinel before decoding a vat ID.", "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5" }, { "file": "application/models/v2/Offer.php", "line": 540, "reason": "Response returns false, dynamic or a public vat ID.", "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5" } ] }, "cancellation_condition_group": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account.", "x-edoobox-contractSource": [ { "file": "application/models/v2/Offer.php", "line": 552, "reason": "Write decodes a public cancellationconditiongroup ID and rejects nonpositive results.", "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5" }, { "file": "application/models/v2/Offer.php", "line": 559, "reason": "Response uses integer zero when no group is assigned.", "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5" } ] }, "country": { "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": [ "country_012345abcdef_123456" ], "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 566 }, "shortdescription": { "x-edoobox-canonicalType": "string", "x-edoobox-maxStoredLength": 250, "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-sourceLine": 579 }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag": { "type": "string", "pattern": "^tag_[a-f0-9]{12}_-?[0-9]+$", "description": "Public tag v2 ID returned for a currently existing record in the selected account; signature, resource type and account ownership are checked by the native hook." }, "type": { "type": "string", "enum": [ "normal", "include", "exclude" ] } }, "additionalProperties": true, "required": [ "tag", "type" ] }, "description": "Replaces normal/include/exclude tag associations. Every supplied tag must be a typed, existing same-account tag and every mode must be recognized before relation writes. Duplicate associations are normalized.", "x-edoobox-contractSource": [ { "file": "application/models/v2/Offerfunc.php", "line": 2534, "reason": "Callback consumes an array of {tag,type} records instead of the aP get placeholder.", "sha256": "0efa50df0d95a6e96901b30e045e68b43f00529f73fcccaf864d23d02c27e63d" }, { "file": "application/models/v2/Offer.php", "line": 605, "reason": "Response builds an array of tag/type objects, not a scalar encoded ID.", "sha256": "abb1c24b2f0d1773a83a689708ab5d7db2a474d05122eb89050e9a941ba8efb5" }, { "file": "application/models/v2/Offerfunc.php", "line": 2557, "lineEnd": 2578, "sha256": "0efa50df0d95a6e96901b30e045e68b43f00529f73fcccaf864d23d02c27e63d", "reason": "All supplied tag IDs/types and the complete same-account tag existence set are validated before offer tag relation writes; unknown modes are rejected." } ] }, "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": 640 } }, "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": [ "offer_012345abcdef_123456" ] } }, "additionalProperties": true, "required": [ "data" ] }, "examples": { "command": { "summary": "Synthetic request envelope; use fields documented by the resource.", "value": { "data": { "name": "Example offer", "category": "category_012345abcdef_123456", "type": "offer" } } } } } } }, "x-edoobox-runtimeMutationGuard": true, "x-edoobox-documentationReview": { "file": "docs/openapi/operation-contracts/03-offers-places.json", "notes": [] }, "x-edoobox-source": { "file": "application/models/v2/Offer.php", "method": "postOffer", "line": 681 }, "x-edoobox-documentationStatus": "reviewed", "x-edoobox-readOnly": false, "x-edoobox-safeForAutomation": false, "x-edoobox-permission": { "resource": "offer", "short": "offe", "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." } } ```