Zum Inhalt
edoobox Docs

Suchen Sie nach einer Aufgabe oder einem Thema, z. B. Rechnung oder Warteliste.
Kostenlos testen 7 Tage unverbindlich testen
Menü
Kostenlos testen 7 Tage unverbindlich testen
OpenAPI herunterladen
noteAPI-Referenz
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

01

Vertrag & Verhalten

Dokumentationsstand
reviewed
Ändert Zustand
Nein
Als readOnly markiert
Ja
Für Automation markiert
Ja
GET-Verhalten laut Spezifikation

read

02

Authentifizierung

Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).

Alternative 1

bearerAuthhttp · bearer

Existing edoobox v2 access token. Never substitute API key/secret headers.

Format: JWT

Security-Schema als JSON
{
  "type": "http",
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
}
accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON
{
  "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."
}

Alternative 2

sessionCookieapiKey

Existing browser login session, with the same permission checks as Bearer authentication.

cookie: _edlogin

Security-Schema als JSON
{
  "type": "apiKey",
  "in": "cookie",
  "name": "_edlogin",
  "description": "Existing browser login session, with the same permission checks as Bearer authentication."
}
accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON
{
  "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."
}

Berechtigungen

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.

Ressource
note · note
Levels
1, 3, 4
Dispatcher-Prüfung
Ja
03

Parameter

Query-Parameter

fieldsoptional

JSON-encoded fields value consumed by RequestAPIData / API_DATA; specific actions may ignore it.

application/json

array
Schema-Beispiel
[
  "id"
]
Array-Elemente
string
Vollständiges Schema als JSON
{
  "type": "array",
  "items": {
    "type": "string"
  },
  "examples": [
    [
      "id"
    ]
  ]
}
Beispiel
[
  "id"
]
filteroptional

JSON-encoded filter value consumed by RequestAPIData / API_DATA; specific actions may ignore it.

application/json

array
Schema-Beispiel
[
  {
    "property": "id",
    "expression": "=",
    "value": "note_012345abcdef_123456"
  }
]
Array-Elemente
object
property string
expression string
value Typ nicht eingeschränkt

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "property": {
        "type": "string"
      },
      "expression": {
        "type": "string"
      },
      "value": {}
    },
    "additionalProperties": true
  },
  "examples": [
    [
      {
        "property": "id",
        "expression": "=",
        "value": "note_012345abcdef_123456"
      }
    ]
  ]
}
Beispiel
[
  {
    "property": "id",
    "expression": "=",
    "value": "note_012345abcdef_123456"
  }
]
limitoptional

JSON-encoded limit value consumed by RequestAPIData / API_DATA; specific actions may ignore it.

application/json

object
Schema-Beispiel
{
  "start": 0,
  "reply": 25
}
start integer
minimum
0

Standardwert: 0

reply integer
maximum
2000

Standardwert: 100

Vollständiges Schema als JSON
{
  "type": "object",
  "properties": {
    "start": {
      "type": "integer",
      "minimum": 0,
      "default": 0
    },
    "reply": {
      "type": "integer",
      "maximum": 2000,
      "default": 100
    }
  },
  "examples": [
    {
      "start": 0,
      "reply": 25
    }
  ]
}
Beispiel
{
  "start": 0,
  "reply": 25
}
orderoptional

JSON-encoded order value consumed by RequestAPIData / API_DATA; specific actions may ignore it.

application/json

array
Schema-Beispiel
[
  {
    "property": "id",
    "value": "ASC"
  }
]
Array-Elemente
object
property string
value string
Erlaubte Werte
"ASC""DESC"

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "property": {
        "type": "string"
      },
      "value": {
        "type": "string",
        "enum": [
          "ASC",
          "DESC"
        ]
      }
    },
    "additionalProperties": true
  },
  "examples": [
    [
      {
        "property": "id",
        "value": "ASC"
      }
    ]
  ]
}
Beispiel
[
  {
    "property": "id",
    "value": "ASC"
  }
]
response_typeoptional

Controls generic collection representation; default is an ID-keyed object.

string
Erlaubte Werte
"array""object"
Schema-Beispiel
"array"
Vollständiges Schema als JSON
{
  "type": "string",
  "enum": [
    "array",
    "object"
  ],
  "examples": [
    "array"
  ]
}

Header

languageoptional

Account language code, where the resource supports setLanguage().

string
Schema-Beispiel
"de"
Vollständiges Schema als JSON
{
  "type": "string",
  "examples": [
    "de"
  ]
}
04

Request Body

Kein Request Body in der Spezifikation beschrieben.

05

Antworten

9

HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.

200application/json

data ist standardmäßig eine nach öffentlichen IDs indizierte Sammlung, bei response_type=array eine Liste; limit enthält die Paginierung.

application/json

object
success boolean
error boolean | string
error_code string
data Typ nicht eingeschränkt

Generic collection (ID-keyed object by default, array for response_type=array) or resource object. Structure fields are partial and action-dependent.

anyOf · Mindestens eine Variante muss passen
Variante 1 object
id string

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.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"note_012345abcdef_123456"
type Typ nicht eingeschränkt

Response field from the resource Structure; dynamic values remain unconstrained.

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-sourceLine": 36
}
subject string

Response field from the resource Structure; dynamic values remain unconstrained.

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-sourceLine": 51
}
message string

Response field from the resource Structure; dynamic values remain unconstrained.

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-sourceLine": 64
}
todo boolean

Response field from the resource Structure; dynamic values remain unconstrained.

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-sourceLine": 73
}
create_time Typ nicht eingeschränkt
anyOf · Mindestens eine Variante muss passen
Variante 1 string
format
"date-time"
Variante 2 Typ nicht eingeschränkt

Fester Wert: false

Feld-Metadaten aus der Spezifikation
{
  "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 Typ nicht eingeschränkt

Connects a note to account-owned resources using their public v2 IDs. Pin relation hooks apply changes separately from the storage getter.

anyOf · Mindestens eine Variante muss passen
Variante 1 object
user array
Array-Elemente
string

Opaque v2 ID returned for a record in the selected account.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
offer array
Array-Elemente
string

Opaque v2 ID returned for a record in the selected account.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
category array
Array-Elemente
string

Opaque v2 ID returned for a record in the selected account.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
booking array
Array-Elemente
string

Opaque v2 ID returned for a record in the selected account.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
invoice array
Array-Elemente
string

Opaque v2 ID returned for a record in the selected account.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
admin array
Array-Elemente
string

Opaque v2 ID returned for a record in the selected account.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
promotioncode array
Array-Elemente
string

Opaque v2 ID returned for a record in the selected account.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Variante 2 array
maxItems
0
Feld-Metadaten aus der Spezifikation
{
  "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"
    }
  ]
}

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Variante 2 array
Array-Elemente
object
id string

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.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"note_012345abcdef_123456"
type Typ nicht eingeschränkt

Response field from the resource Structure; dynamic values remain unconstrained.

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-sourceLine": 36
}
subject string

Response field from the resource Structure; dynamic values remain unconstrained.

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-sourceLine": 51
}
message string

Response field from the resource Structure; dynamic values remain unconstrained.

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-sourceLine": 64
}
todo boolean

Response field from the resource Structure; dynamic values remain unconstrained.

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-sourceLine": 73
}
create_time Typ nicht eingeschränkt
anyOf · Mindestens eine Variante muss passen
Variante 1 string
format
"date-time"
Variante 2 Typ nicht eingeschränkt

Fester Wert: false

Feld-Metadaten aus der Spezifikation
{
  "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 Typ nicht eingeschränkt

Connects a note to account-owned resources using their public v2 IDs. Pin relation hooks apply changes separately from the storage getter.

anyOf · Mindestens eine Variante muss passen
Variante 1 object
user array
Array-Elemente
string

Opaque v2 ID returned for a record in the selected account.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
offer array
Array-Elemente
string

Opaque v2 ID returned for a record in the selected account.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
category array
Array-Elemente
string

Opaque v2 ID returned for a record in the selected account.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
booking array
Array-Elemente
string

Opaque v2 ID returned for a record in the selected account.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
invoice array
Array-Elemente
string

Opaque v2 ID returned for a record in the selected account.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
admin array
Array-Elemente
string

Opaque v2 ID returned for a record in the selected account.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
promotioncode array
Array-Elemente
string

Opaque v2 ID returned for a record in the selected account.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Variante 2 array
maxItems
0
Feld-Metadaten aus der Spezifikation
{
  "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"
    }
  ]
}

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Variante 3 object
Schema für zusätzliche Felder
object
id string

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.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"note_012345abcdef_123456"
type Typ nicht eingeschränkt

Response field from the resource Structure; dynamic values remain unconstrained.

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-sourceLine": 36
}
subject string

Response field from the resource Structure; dynamic values remain unconstrained.

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-sourceLine": 51
}
message string

Response field from the resource Structure; dynamic values remain unconstrained.

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-sourceLine": 64
}
todo boolean

Response field from the resource Structure; dynamic values remain unconstrained.

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-sourceLine": 73
}
create_time Typ nicht eingeschränkt
anyOf · Mindestens eine Variante muss passen
Variante 1 string
format
"date-time"
Variante 2 Typ nicht eingeschränkt

Fester Wert: false

Feld-Metadaten aus der Spezifikation
{
  "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 Typ nicht eingeschränkt

Connects a note to account-owned resources using their public v2 IDs. Pin relation hooks apply changes separately from the storage getter.

anyOf · Mindestens eine Variante muss passen
Variante 1 object
user array
Array-Elemente
string

Opaque v2 ID returned for a record in the selected account.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
offer array
Array-Elemente
string

Opaque v2 ID returned for a record in the selected account.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
category array
Array-Elemente
string

Opaque v2 ID returned for a record in the selected account.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
booking array
Array-Elemente
string

Opaque v2 ID returned for a record in the selected account.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
invoice array
Array-Elemente
string

Opaque v2 ID returned for a record in the selected account.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
admin array
Array-Elemente
string

Opaque v2 ID returned for a record in the selected account.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
promotioncode array
Array-Elemente
string

Opaque v2 ID returned for a record in the selected account.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Variante 2 array
maxItems
0
Feld-Metadaten aus der Spezifikation
{
  "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"
    }
  ]
}

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

type string

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON
{
  "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
}
Beispiel
{
  "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
  }
}
400application/json

Invalid request.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED40006"
}
401application/json

Missing/expired token, missing account context, account paused or model-specific authorization failure.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED40103"
}
402application/json

Missing/invalid action data or subscription/operation restriction.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED80100"
}
403application/json

Permission denied. Browser CORS rejection may have an empty body.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED40340"
}
404application/json

Unknown resource/action or unsupported method.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED80019"
}
422application/json

Validation failed.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED80020"
}
429application/json

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.

Response Header

Retry-After

Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.

string
Schema-Beispiel
"30"
Vollständiges Schema als JSON
{
  "type": "string",
  "examples": [
    "30"
  ]
}

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED42902"
}
502application/json

Server-side operation failed.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED50201"
}
06

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Note.php:285getNote()

Diese Angaben stammen unverändert aus der gelieferten OpenAPI-Datei. Zusätzliche Freigaben, Vorbedingungen, sensible Felder und Hinweise stehen in den Erweiterungen.

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."
}
Vollständige Operation als 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."
  }
}
Cookies & Datenschutz
Notwendig

Für Sicherheit, Navigation, Formulare und den technischen Betrieb der Website.

Immer aktiv
Datenschutzerklärung