# GET /v2/note/list Notizen auflisten Liest manuelle und Systemnotizen einschließlich TODO-Status und Verknüpfungen in pinned. Beziehungssuchen unterstützen öffentliche IDs für offer, category, user, booking, invoice, admin und promotioncode. fields, filter, limit und order wählen Felder und Ergebnismenge. data bleibt auch bei einer einzelnen ID eine ID-indizierte Sammlung; response_type=array liefert eine Liste. - Operation-ID: get_v2_note_list - Dokumentation: /docs/api/v2/operations/get-v2-note-list-53b988db8530/ - OpenAPI-Version: 3.2.1 - Vollständige Spezifikation: /docs/api/v2/openapi.json - Dokumentationsstatus: reviewed - Ändert Zustand: nein, gemäss Annotation - Für Automation freigegeben: ja, siehe Voraussetzungen ## Server Serverwerte stammen unverändert aus der Datei. Eine lokale Entwicklungsadresse ist keine bestätigte Produktionsadresse. `API_ORIGIN` muss auf die passende Instanz gesetzt werden. ```json [ { "url": "https://app2.edoobox.com", "description": "edoobox API" } ] ``` ## Authentifizierung Eine der folgenden Alternativen genügt (ODER). Innerhalb einer Alternative müssen alle Verfahren gemeinsam erfüllt sein (UND). 1. **bearerAuth** (HTTP bearer) — Existing edoobox v2 access token. Never substitute API key/secret headers. **UND** **accountContext** (header: edid) — Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account. 2. **sessionCookie** (cookie: _edlogin) — Existing browser login session, with the same permission checks as Bearer authentication. **UND** **accountContext** (header: edid) — Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account. ### Wirksame Security Requirements und vollständige Verfahren ```json { "security": [ { "bearerAuth": [], "accountContext": [] }, { "sessionCookie": [], "accountContext": [] } ], "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Existing edoobox v2 access token. Never substitute API key/secret headers." }, "accountContext": { "type": "apiKey", "in": "header", "name": "edid", "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account." }, "sessionCookie": { "type": "apiKey", "in": "cookie", "name": "_edlogin", "description": "Existing browser login session, with the same permission checks as Bearer authentication." } } } ``` ## Parameter | Name | Ort | Pflicht | Beschreibung | | --- | --- | --- | --- | | fields | query | nein | JSON-encoded fields value consumed by RequestAPIData / API_DATA; specific actions may ignore it. | | filter | query | nein | JSON-encoded filter value consumed by RequestAPIData / API_DATA; specific actions may ignore it. | | limit | query | nein | JSON-encoded limit value consumed by RequestAPIData / API_DATA; specific actions may ignore it. | | order | query | nein | JSON-encoded order value consumed by RequestAPIData / API_DATA; specific actions may ignore it. | | response_type | query | nein | Controls generic collection representation; default is an ID-keyed object. | | language | header | nein | Account language code, where the resource supports setLanguage(). | ### Vollständige wirksame Parameterdefinitionen ```json [ { "name": "fields", "in": "query", "required": false, "description": "JSON-encoded fields value consumed by RequestAPIData / API_DATA; specific actions may ignore it.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "examples": [ [ "id" ] ] }, "example": [ "id" ] } } }, { "name": "filter", "in": "query", "required": false, "description": "JSON-encoded filter value consumed by RequestAPIData / API_DATA; specific actions may ignore it.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "expression": { "type": "string" }, "value": {} }, "additionalProperties": true }, "examples": [ [ { "property": "id", "expression": "=", "value": "note_012345abcdef_123456" } ] ] }, "example": [ { "property": "id", "expression": "=", "value": "note_012345abcdef_123456" } ] } } }, { "name": "limit", "in": "query", "required": false, "description": "JSON-encoded limit value consumed by RequestAPIData / API_DATA; specific actions may ignore it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "default": 0 }, "reply": { "type": "integer", "maximum": 2000, "default": 100 } }, "examples": [ { "start": 0, "reply": 25 } ] }, "example": { "start": 0, "reply": 25 } } } }, { "name": "order", "in": "query", "required": false, "description": "JSON-encoded order value consumed by RequestAPIData / API_DATA; specific actions may ignore it.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "value": { "type": "string", "enum": [ "ASC", "DESC" ] } }, "additionalProperties": true }, "examples": [ [ { "property": "id", "value": "ASC" } ] ] }, "example": [ { "property": "id", "value": "ASC" } ] } } }, { "name": "response_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "array", "object" ], "examples": [ "array" ] }, "description": "Controls generic collection representation; default is an ID-keyed object." }, { "name": "language", "in": "header", "required": false, "description": "Account language code, where the resource supports setLanguage().", "schema": { "type": "string", "examples": [ "de" ] } } ] ``` ## Anfrage Kein Request Body deklariert. ## Antworten HTTP-Status und Antwortinhalt gemeinsam auswerten. Die folgenden Beschreibungen und Schemata sind die Angaben der Quelldatei. ```json { "200": { "description": "data ist standardmäßig eine nach öffentlichen IDs indizierte Sammlung, bei response_type=array eine Liste; limit enthält die Paginierung.", "content": { "application/json": { "example": { "success": true, "error": false, "data": { "note_012345abcdef_123456": { "id": "note_012345abcdef_123456", "type": 2, "subject": "Rückfrage zum Kurs", "message": "Bitte telefonisch melden.", "todo": true, "create_time": "2026-10-22T10:00:00+00:00", "pinned": { "offer": [ "offer_012345abcdef_123456" ] } } }, "limit": { "start": 0, "reply": 100, "total": 1 } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": [ "boolean", "string" ] }, "error_code": { "type": "string" }, "data": { "description": "Generic collection (ID-keyed object by default, array for response_type=array) or resource object. Structure fields are partial and action-dependent.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "note_012345abcdef_123456" ] }, "type": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 36 }, "subject": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 51, "type": "string" }, "message": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 64, "type": "string" }, "todo": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 73, "type": "boolean" }, "create_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "const": false } ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Note.php", "line": 83, "lineStart": 83, "lineEnd": 93, "sha256": "943c7906d13ad4dfa8fdbc3f78de3334f21641a669818eb9f863a151c677854d", "spanSha256": "847028498f7c3645b2f58a8fc95175137900876cd5d71122703b02ecacbe1838", "reason": "Structure getter, output setter and field flags." }, { "file": "application/helpers/edooboxhelp_helper.php", "line": 11629, "lineStart": 11629, "lineEnd": 11639, "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e", "spanSha256": "a6fb9b218b0bdd5d6bc05d62034b2a1096d3279599319f181e03bc4a6fe7d83a", "reason": "dQ returns ISO date-time or false from stored time." }, { "file": "application/models/v2/Note.php", "line": 210, "lineStart": 210, "lineEnd": 216, "sha256": "943c7906d13ad4dfa8fdbc3f78de3334f21641a669818eb9f863a151c677854d", "spanSha256": "b24296456b7b463c1b2d9ff3dbdc06f338b67791654193656596a47873f0e771", "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" } ] }, "pinned": { "anyOf": [ { "type": "object", "properties": { "user": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "offer": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "category": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "booking": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "invoice": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "admin": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "promotioncode": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } } }, "additionalProperties": true }, { "type": "array", "maxItems": 0 } ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Notefunc.php", "line": 7, "lineEnd": 11, "reason": "PUT validates the complete pinned object before even loading existing pin relations.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Notefunc.php", "line": 105, "lineEnd": 109, "reason": "POST before-insert runs the same full secondary-target validation; an empty final pin set is not a supported create.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Notefunc.php", "line": 139, "lineEnd": 142, "reason": "POST relation insertion rechecks the complete normalized pin set.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Notefunc.php", "line": 216, "lineEnd": 259, "reason": "Seven exact resource groups require list values and typed public IDs; batched same-account existence and resource subtype checks precede all pin changes.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Note.php", "line": 171, "lineEnd": 201, "reason": "Response still groups public IDs by resource; an empty stored result is PHP [].", "sha256": "943c7906d13ad4dfa8fdbc3f78de3334f21641a669818eb9f863a151c677854d" } ], "description": "Connects a note to account-owned resources using their public v2 IDs.\nPin relation hooks apply changes separately from the storage getter." } }, "additionalProperties": true }, { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "note_012345abcdef_123456" ] }, "type": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 36 }, "subject": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 51, "type": "string" }, "message": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 64, "type": "string" }, "todo": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 73, "type": "boolean" }, "create_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "const": false } ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Note.php", "line": 83, "lineStart": 83, "lineEnd": 93, "sha256": "943c7906d13ad4dfa8fdbc3f78de3334f21641a669818eb9f863a151c677854d", "spanSha256": "847028498f7c3645b2f58a8fc95175137900876cd5d71122703b02ecacbe1838", "reason": "Structure getter, output setter and field flags." }, { "file": "application/helpers/edooboxhelp_helper.php", "line": 11629, "lineStart": 11629, "lineEnd": 11639, "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e", "spanSha256": "a6fb9b218b0bdd5d6bc05d62034b2a1096d3279599319f181e03bc4a6fe7d83a", "reason": "dQ returns ISO date-time or false from stored time." }, { "file": "application/models/v2/Note.php", "line": 210, "lineStart": 210, "lineEnd": 216, "sha256": "943c7906d13ad4dfa8fdbc3f78de3334f21641a669818eb9f863a151c677854d", "spanSha256": "b24296456b7b463c1b2d9ff3dbdc06f338b67791654193656596a47873f0e771", "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" } ] }, "pinned": { "anyOf": [ { "type": "object", "properties": { "user": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "offer": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "category": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "booking": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "invoice": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "admin": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "promotioncode": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } } }, "additionalProperties": true }, { "type": "array", "maxItems": 0 } ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Notefunc.php", "line": 7, "lineEnd": 11, "reason": "PUT validates the complete pinned object before even loading existing pin relations.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Notefunc.php", "line": 105, "lineEnd": 109, "reason": "POST before-insert runs the same full secondary-target validation; an empty final pin set is not a supported create.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Notefunc.php", "line": 139, "lineEnd": 142, "reason": "POST relation insertion rechecks the complete normalized pin set.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Notefunc.php", "line": 216, "lineEnd": 259, "reason": "Seven exact resource groups require list values and typed public IDs; batched same-account existence and resource subtype checks precede all pin changes.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Note.php", "line": 171, "lineEnd": 201, "reason": "Response still groups public IDs by resource; an empty stored result is PHP [].", "sha256": "943c7906d13ad4dfa8fdbc3f78de3334f21641a669818eb9f863a151c677854d" } ], "description": "Connects a note to account-owned resources using their public v2 IDs.\nPin relation hooks apply changes separately from the storage getter." } }, "additionalProperties": true } }, { "type": "object", "additionalProperties": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "note_012345abcdef_123456" ] }, "type": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 36 }, "subject": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 51, "type": "string" }, "message": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 64, "type": "string" }, "todo": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 73, "type": "boolean" }, "create_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "const": false } ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Note.php", "line": 83, "lineStart": 83, "lineEnd": 93, "sha256": "943c7906d13ad4dfa8fdbc3f78de3334f21641a669818eb9f863a151c677854d", "spanSha256": "847028498f7c3645b2f58a8fc95175137900876cd5d71122703b02ecacbe1838", "reason": "Structure getter, output setter and field flags." }, { "file": "application/helpers/edooboxhelp_helper.php", "line": 11629, "lineStart": 11629, "lineEnd": 11639, "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e", "spanSha256": "a6fb9b218b0bdd5d6bc05d62034b2a1096d3279599319f181e03bc4a6fe7d83a", "reason": "dQ returns ISO date-time or false from stored time." }, { "file": "application/models/v2/Note.php", "line": 210, "lineStart": 210, "lineEnd": 216, "sha256": "943c7906d13ad4dfa8fdbc3f78de3334f21641a669818eb9f863a151c677854d", "spanSha256": "b24296456b7b463c1b2d9ff3dbdc06f338b67791654193656596a47873f0e771", "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" } ] }, "pinned": { "anyOf": [ { "type": "object", "properties": { "user": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "offer": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "category": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "booking": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "invoice": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "admin": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "promotioncode": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } } }, "additionalProperties": true }, { "type": "array", "maxItems": 0 } ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Notefunc.php", "line": 7, "lineEnd": 11, "reason": "PUT validates the complete pinned object before even loading existing pin relations.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Notefunc.php", "line": 105, "lineEnd": 109, "reason": "POST before-insert runs the same full secondary-target validation; an empty final pin set is not a supported create.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Notefunc.php", "line": 139, "lineEnd": 142, "reason": "POST relation insertion rechecks the complete normalized pin set.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Notefunc.php", "line": 216, "lineEnd": 259, "reason": "Seven exact resource groups require list values and typed public IDs; batched same-account existence and resource subtype checks precede all pin changes.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Note.php", "line": 171, "lineEnd": 201, "reason": "Response still groups public IDs by resource; an empty stored result is PHP [].", "sha256": "943c7906d13ad4dfa8fdbc3f78de3334f21641a669818eb9f863a151c677854d" } ], "description": "Connects a note to account-owned resources using their public v2 IDs.\nPin relation hooks apply changes separately from the storage getter." } }, "additionalProperties": true } } ] }, "type": { "type": "string" } }, "additionalProperties": true } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "example": { "success": false, "error": "ED40006" } } } }, "401": { "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.", "content": { "application/json": { "example": { "success": false, "error": "ED40103" } } } }, "402": { "description": "Missing/invalid action data or subscription/operation restriction.", "content": { "application/json": { "example": { "success": false, "error": "ED80100" } } } }, "403": { "description": "Permission denied. Browser CORS rejection may have an empty body.", "content": { "application/json": { "example": { "success": false, "error": "ED40340" } } } }, "404": { "description": "Unknown resource/action or unsupported method.", "content": { "application/json": { "example": { "success": false, "error": "ED80019" } } } }, "422": { "description": "Validation failed.", "content": { "application/json": { "example": { "success": false, "error": "ED80020" } } } }, "429": { "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.", "content": { "application/json": { "example": { "success": false, "error": "ED42902" } } }, "headers": { "Retry-After": { "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.", "schema": { "type": "string", "examples": [ "30" ] } } } }, "502": { "description": "Server-side operation failed.", "content": { "application/json": { "example": { "success": false, "error": "ED50201" } } } } } ``` ## Aufrufbeispiele Anpassen vor dem Ausführen. Platzhalter und veröffentlichte Beispiele sind synthetisch. Die Beispiele senden hier keine Anfrage; sie ergänzen keine unbekannten Pflichtfelder. ### cURL ```sh # Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich. : "${API_ORIGIN:?API_ORIGIN setzen}" : "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}" : "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}" curl --request 'GET' \ --url "${API_ORIGIN%/}"'/v2/note/list' \ --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \ --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" ``` ### JavaScript (Node.js) ```javascript // Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich. const required = (name) => { const value = process.env[name]; if (!value) throw new Error(`Set ${name}`); return value; }; let path = "/v2/note/list"; const origin = required('API_ORIGIN'); const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path); const headers = {}; headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH"); headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT"); const response = await fetch(url, { method: "GET", headers, redirect: 'manual' }); const text = await response.text(); console.log(response.status, text); // HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen. ``` ### Python ```python # Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich. import os import urllib.parse import urllib.request import urllib.error path = "/v2/note/list" url = os.environ["API_ORIGIN"].rstrip("/") + path headers = {} headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"] headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"] # Redirects nicht automatisch verfolgen. class NoRedirect(urllib.request.HTTPRedirectHandler): def redirect_request(self, req, fp, code, msg, headers, newurl): return None request = urllib.request.Request(url, headers=headers, method="GET") try: response = urllib.request.build_opener(NoRedirect).open(request, timeout=30) except urllib.error.HTTPError as error: response = error print(response.status, response.read().decode("utf-8", errors="replace")) # HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen. ``` ## Vollständige Operationsdefinition und edoobox-Hinweise Alle Originalfelder einschliesslich `x-edoobox-*`, requestBody und responses bleiben erhalten. Teilweise dokumentierte Schemata sind kein vollständiger Validierungsvertrag. ```json { "operationId": "get_v2_note_list", "summary": "Notizen auflisten", "description": "Liest manuelle und Systemnotizen einschließlich TODO-Status und Verknüpfungen in pinned. Beziehungssuchen unterstützen öffentliche IDs für offer, category, user, booking, invoice, admin und promotioncode. fields, filter, limit und order wählen Felder und Ergebnismenge. data bleibt auch bei einer einzelnen ID eine ID-indizierte Sammlung; response_type=array liefert eine Liste.", "tags": [ "note" ], "security": [ { "bearerAuth": [], "accountContext": [] }, { "sessionCookie": [], "accountContext": [] } ], "parameters": [ { "name": "fields", "in": "query", "required": false, "description": "JSON-encoded fields value consumed by RequestAPIData / API_DATA; specific actions may ignore it.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "examples": [ [ "id" ] ] }, "example": [ "id" ] } } }, { "name": "filter", "in": "query", "required": false, "description": "JSON-encoded filter value consumed by RequestAPIData / API_DATA; specific actions may ignore it.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "expression": { "type": "string" }, "value": {} }, "additionalProperties": true }, "examples": [ [ { "property": "id", "expression": "=", "value": "note_012345abcdef_123456" } ] ] }, "example": [ { "property": "id", "expression": "=", "value": "note_012345abcdef_123456" } ] } } }, { "name": "limit", "in": "query", "required": false, "description": "JSON-encoded limit value consumed by RequestAPIData / API_DATA; specific actions may ignore it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "default": 0 }, "reply": { "type": "integer", "maximum": 2000, "default": 100 } }, "examples": [ { "start": 0, "reply": 25 } ] }, "example": { "start": 0, "reply": 25 } } } }, { "name": "order", "in": "query", "required": false, "description": "JSON-encoded order value consumed by RequestAPIData / API_DATA; specific actions may ignore it.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "value": { "type": "string", "enum": [ "ASC", "DESC" ] } }, "additionalProperties": true }, "examples": [ [ { "property": "id", "value": "ASC" } ] ] }, "example": [ { "property": "id", "value": "ASC" } ] } } }, { "name": "response_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "array", "object" ], "examples": [ "array" ] }, "description": "Controls generic collection representation; default is an ID-keyed object." }, { "name": "language", "in": "header", "required": false, "description": "Account language code, where the resource supports setLanguage().", "schema": { "type": "string", "examples": [ "de" ] } } ], "responses": { "200": { "description": "data ist standardmäßig eine nach öffentlichen IDs indizierte Sammlung, bei response_type=array eine Liste; limit enthält die Paginierung.", "content": { "application/json": { "example": { "success": true, "error": false, "data": { "note_012345abcdef_123456": { "id": "note_012345abcdef_123456", "type": 2, "subject": "Rückfrage zum Kurs", "message": "Bitte telefonisch melden.", "todo": true, "create_time": "2026-10-22T10:00:00+00:00", "pinned": { "offer": [ "offer_012345abcdef_123456" ] } } }, "limit": { "start": 0, "reply": 100, "total": 1 } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": [ "boolean", "string" ] }, "error_code": { "type": "string" }, "data": { "description": "Generic collection (ID-keyed object by default, array for response_type=array) or resource object. Structure fields are partial and action-dependent.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "note_012345abcdef_123456" ] }, "type": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 36 }, "subject": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 51, "type": "string" }, "message": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 64, "type": "string" }, "todo": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 73, "type": "boolean" }, "create_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "const": false } ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Note.php", "line": 83, "lineStart": 83, "lineEnd": 93, "sha256": "943c7906d13ad4dfa8fdbc3f78de3334f21641a669818eb9f863a151c677854d", "spanSha256": "847028498f7c3645b2f58a8fc95175137900876cd5d71122703b02ecacbe1838", "reason": "Structure getter, output setter and field flags." }, { "file": "application/helpers/edooboxhelp_helper.php", "line": 11629, "lineStart": 11629, "lineEnd": 11639, "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e", "spanSha256": "a6fb9b218b0bdd5d6bc05d62034b2a1096d3279599319f181e03bc4a6fe7d83a", "reason": "dQ returns ISO date-time or false from stored time." }, { "file": "application/models/v2/Note.php", "line": 210, "lineStart": 210, "lineEnd": 216, "sha256": "943c7906d13ad4dfa8fdbc3f78de3334f21641a669818eb9f863a151c677854d", "spanSha256": "b24296456b7b463c1b2d9ff3dbdc06f338b67791654193656596a47873f0e771", "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" } ] }, "pinned": { "anyOf": [ { "type": "object", "properties": { "user": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "offer": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "category": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "booking": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "invoice": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "admin": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "promotioncode": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } } }, "additionalProperties": true }, { "type": "array", "maxItems": 0 } ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Notefunc.php", "line": 7, "lineEnd": 11, "reason": "PUT validates the complete pinned object before even loading existing pin relations.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Notefunc.php", "line": 105, "lineEnd": 109, "reason": "POST before-insert runs the same full secondary-target validation; an empty final pin set is not a supported create.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Notefunc.php", "line": 139, "lineEnd": 142, "reason": "POST relation insertion rechecks the complete normalized pin set.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Notefunc.php", "line": 216, "lineEnd": 259, "reason": "Seven exact resource groups require list values and typed public IDs; batched same-account existence and resource subtype checks precede all pin changes.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Note.php", "line": 171, "lineEnd": 201, "reason": "Response still groups public IDs by resource; an empty stored result is PHP [].", "sha256": "943c7906d13ad4dfa8fdbc3f78de3334f21641a669818eb9f863a151c677854d" } ], "description": "Connects a note to account-owned resources using their public v2 IDs.\nPin relation hooks apply changes separately from the storage getter." } }, "additionalProperties": true }, { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "note_012345abcdef_123456" ] }, "type": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 36 }, "subject": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 51, "type": "string" }, "message": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 64, "type": "string" }, "todo": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 73, "type": "boolean" }, "create_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "const": false } ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Note.php", "line": 83, "lineStart": 83, "lineEnd": 93, "sha256": "943c7906d13ad4dfa8fdbc3f78de3334f21641a669818eb9f863a151c677854d", "spanSha256": "847028498f7c3645b2f58a8fc95175137900876cd5d71122703b02ecacbe1838", "reason": "Structure getter, output setter and field flags." }, { "file": "application/helpers/edooboxhelp_helper.php", "line": 11629, "lineStart": 11629, "lineEnd": 11639, "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e", "spanSha256": "a6fb9b218b0bdd5d6bc05d62034b2a1096d3279599319f181e03bc4a6fe7d83a", "reason": "dQ returns ISO date-time or false from stored time." }, { "file": "application/models/v2/Note.php", "line": 210, "lineStart": 210, "lineEnd": 216, "sha256": "943c7906d13ad4dfa8fdbc3f78de3334f21641a669818eb9f863a151c677854d", "spanSha256": "b24296456b7b463c1b2d9ff3dbdc06f338b67791654193656596a47873f0e771", "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" } ] }, "pinned": { "anyOf": [ { "type": "object", "properties": { "user": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "offer": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "category": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "booking": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "invoice": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "admin": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "promotioncode": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } } }, "additionalProperties": true }, { "type": "array", "maxItems": 0 } ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Notefunc.php", "line": 7, "lineEnd": 11, "reason": "PUT validates the complete pinned object before even loading existing pin relations.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Notefunc.php", "line": 105, "lineEnd": 109, "reason": "POST before-insert runs the same full secondary-target validation; an empty final pin set is not a supported create.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Notefunc.php", "line": 139, "lineEnd": 142, "reason": "POST relation insertion rechecks the complete normalized pin set.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Notefunc.php", "line": 216, "lineEnd": 259, "reason": "Seven exact resource groups require list values and typed public IDs; batched same-account existence and resource subtype checks precede all pin changes.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Note.php", "line": 171, "lineEnd": 201, "reason": "Response still groups public IDs by resource; an empty stored result is PHP [].", "sha256": "943c7906d13ad4dfa8fdbc3f78de3334f21641a669818eb9f863a151c677854d" } ], "description": "Connects a note to account-owned resources using their public v2 IDs.\nPin relation hooks apply changes separately from the storage getter." } }, "additionalProperties": true } }, { "type": "object", "additionalProperties": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "note_012345abcdef_123456" ] }, "type": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 36 }, "subject": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 51, "type": "string" }, "message": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 64, "type": "string" }, "todo": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 73, "type": "boolean" }, "create_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "const": false } ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Note.php", "line": 83, "lineStart": 83, "lineEnd": 93, "sha256": "943c7906d13ad4dfa8fdbc3f78de3334f21641a669818eb9f863a151c677854d", "spanSha256": "847028498f7c3645b2f58a8fc95175137900876cd5d71122703b02ecacbe1838", "reason": "Structure getter, output setter and field flags." }, { "file": "application/helpers/edooboxhelp_helper.php", "line": 11629, "lineStart": 11629, "lineEnd": 11639, "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e", "spanSha256": "a6fb9b218b0bdd5d6bc05d62034b2a1096d3279599319f181e03bc4a6fe7d83a", "reason": "dQ returns ISO date-time or false from stored time." }, { "file": "application/models/v2/Note.php", "line": 210, "lineStart": 210, "lineEnd": 216, "sha256": "943c7906d13ad4dfa8fdbc3f78de3334f21641a669818eb9f863a151c677854d", "spanSha256": "b24296456b7b463c1b2d9ff3dbdc06f338b67791654193656596a47873f0e771", "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" } ] }, "pinned": { "anyOf": [ { "type": "object", "properties": { "user": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "offer": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "category": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "booking": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "invoice": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "admin": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } }, "promotioncode": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque v2 ID returned for a record in the selected account." } } }, "additionalProperties": true }, { "type": "array", "maxItems": 0 } ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Notefunc.php", "line": 7, "lineEnd": 11, "reason": "PUT validates the complete pinned object before even loading existing pin relations.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Notefunc.php", "line": 105, "lineEnd": 109, "reason": "POST before-insert runs the same full secondary-target validation; an empty final pin set is not a supported create.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Notefunc.php", "line": 139, "lineEnd": 142, "reason": "POST relation insertion rechecks the complete normalized pin set.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Notefunc.php", "line": 216, "lineEnd": 259, "reason": "Seven exact resource groups require list values and typed public IDs; batched same-account existence and resource subtype checks precede all pin changes.", "sha256": "cb4cf09a6fd8a88f94bca520229db0ab300b37f23d9309e176955a6839e74c0c" }, { "file": "application/models/v2/Note.php", "line": 171, "lineEnd": 201, "reason": "Response still groups public IDs by resource; an empty stored result is PHP [].", "sha256": "943c7906d13ad4dfa8fdbc3f78de3334f21641a669818eb9f863a151c677854d" } ], "description": "Connects a note to account-owned resources using their public v2 IDs.\nPin relation hooks apply changes separately from the storage getter." } }, "additionalProperties": true } } ] }, "type": { "type": "string" } }, "additionalProperties": true } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "example": { "success": false, "error": "ED40006" } } } }, "401": { "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.", "content": { "application/json": { "example": { "success": false, "error": "ED40103" } } } }, "402": { "description": "Missing/invalid action data or subscription/operation restriction.", "content": { "application/json": { "example": { "success": false, "error": "ED80100" } } } }, "403": { "description": "Permission denied. Browser CORS rejection may have an empty body.", "content": { "application/json": { "example": { "success": false, "error": "ED40340" } } } }, "404": { "description": "Unknown resource/action or unsupported method.", "content": { "application/json": { "example": { "success": false, "error": "ED80019" } } } }, "422": { "description": "Validation failed.", "content": { "application/json": { "example": { "success": false, "error": "ED80020" } } } }, "429": { "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.", "content": { "application/json": { "example": { "success": false, "error": "ED42902" } } }, "headers": { "Retry-After": { "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.", "schema": { "type": "string", "examples": [ "30" ] } } } }, "502": { "description": "Server-side operation failed.", "content": { "application/json": { "example": { "success": false, "error": "ED50201" } } } } }, "x-edoobox-mutates-state": false, "x-edoobox-runtimeMutationGuard": false, "x-edoobox-get-effect": "read", "x-edoobox-documentationReview": { "file": "docs/openapi/operation-contracts/09-messages-ai.json", "notes": [] }, "x-edoobox-source": { "file": "application/models/v2/Note.php", "method": "getNote", "line": 285 }, "x-edoobox-documentationStatus": "reviewed", "x-edoobox-readOnly": true, "x-edoobox-safeForAutomation": true, "x-edoobox-permission": { "resource": "note", "short": "note", "checkedByDispatcher": true, "levels": [ 1, 3, 4 ], "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope." } } ```