noteAPI-Referenz

POST/v2/note

Notiz anlegen

Erstellt eine manuelle Notiz (type wird serverseitig auf 2 gesetzt) und verknüpft sie mit mindestens einem vorhandenen, kontoeigenen Objekt in pinned. Nur die dokumentierten Pin-Typen sind erlaubt; Werte sind Listen öffentlicher v2-IDs. Bei todo=true entsteht eine offene Aufgabe. data erlaubt ein einzelnes Objekt oder höchstens 100 Objekte als Batch; die Antwort enthält eine ID bzw. eine ID-Liste.

Operation-ID post_v2_note

Vertrag & Verhalten

Dokumentationsstand: reviewed
Ändert Zustand: Ja
Als readOnly markiert: Nein
Für Automation markiert: Nein

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: 2, 3, 4
Dispatcher-Prüfung: Ja

Parameter

Header

languageoptional

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

string

Schema-Beispiel

"de"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "de"
  ]
}

X-Edoobox-If-Revisionoptional

Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review.

string

pattern: "^[a-f0-9]{32}$"

Schema-Beispiel

"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$",
  "examples": [
    "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  ]
}

Request Body

erforderlich

`application/json`

object

data Typ nicht eingeschränkt erforderlich

anyOf · Mindestens eine Variante muss passen

Variante 1 object

Bei Erstellung immer 2 (manuelle Notiz), unabhängig vom Eingabewert; bei Änderung numerische Umwandlung.

Schema-Beispiel

Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 250 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.

Schema-Beispiel

"Rückfrage zum Kurs"

Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 1000 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.

Schema-Beispiel

"Bitte telefonisch melden."

Wird nach PHP-Wahrheitswert zu true/false normalisiert; boolesche JSON-Werte verwenden.

Schema-Beispiel

true

pinned object erforderlich

Connects a note to account-owned resources using their public v2 IDs. Pin relation hooks apply changes separately from the storage getter. Verknüpft die Notiz mit vorhandenen Objekten desselben Kontos. Die Schlüssel user, offer, category, booking, invoice, admin und promotioncode enthalten jeweils Listen passender öffentlicher v2-IDs; Roh-DB-IDs, fremde Objekte und unbekannte Pin-Typen werden abgelehnt. Beim Anlegen und beim Ersetzen der Verknüpfungen muss mindestens eine gültige Referenz erhalten bleiben. Die Beziehungshooks speichern die Verknüpfungen getrennt vom normalen Feldsetter; ein Update von pinned ersetzt die vorherige Auswahl, während ein fehlendes pinned die Verknüpfungen unverändert lässt.

user array

Array-Elemente

string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

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

offer array

Array-Elemente

string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

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

category array

Array-Elemente

string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

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

booking array

Array-Elemente

string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

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

invoice array

Array-Elemente

string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

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

admin array

Array-Elemente

string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

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

promotioncode array

Array-Elemente

string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

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

anyOf · Mindestens eine Variante muss passen

Variante 1 Typ nicht eingeschränkt

user Typ nicht eingeschränkt erforderlich

minItems: 1

Variante 2 Typ nicht eingeschränkt

offer Typ nicht eingeschränkt erforderlich

minItems: 1

Variante 3 Typ nicht eingeschränkt

category Typ nicht eingeschränkt erforderlich

minItems: 1

Variante 4 Typ nicht eingeschränkt

booking Typ nicht eingeschränkt erforderlich

minItems: 1

Variante 5 Typ nicht eingeschränkt

invoice Typ nicht eingeschränkt erforderlich

minItems: 1

Variante 6 Typ nicht eingeschränkt

admin Typ nicht eingeschränkt erforderlich

minItems: 1

Variante 7 Typ nicht eingeschränkt

promotioncode Typ nicht eingeschränkt erforderlich

minItems: 1

Zusätzliche Felder sind in diesem Teilschema ausgeschlossen.

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

Variante 2 array

minItems: 1
maxItems: 100

Array-Elemente

object

Bei Erstellung immer 2 (manuelle Notiz), unabhängig vom Eingabewert; bei Änderung numerische Umwandlung.

Schema-Beispiel

Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 250 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.

Schema-Beispiel

"Rückfrage zum Kurs"

Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 1000 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.

Schema-Beispiel

"Bitte telefonisch melden."

Wird nach PHP-Wahrheitswert zu true/false normalisiert; boolesche JSON-Werte verwenden.

Schema-Beispiel

true

pinned object erforderlich

user array

Array-Elemente

string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

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

offer array

Array-Elemente

string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

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

category array

Array-Elemente

string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

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

booking array

Array-Elemente

string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

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

invoice array

Array-Elemente

string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

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

admin array

Array-Elemente

string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

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

promotioncode array

Array-Elemente

string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

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

anyOf · Mindestens eine Variante muss passen

Variante 1 Typ nicht eingeschränkt

user Typ nicht eingeschränkt erforderlich

minItems: 1

Variante 2 Typ nicht eingeschränkt

offer Typ nicht eingeschränkt erforderlich

minItems: 1

Variante 3 Typ nicht eingeschränkt

category Typ nicht eingeschränkt erforderlich

minItems: 1

Variante 4 Typ nicht eingeschränkt

booking Typ nicht eingeschränkt erforderlich

minItems: 1

Variante 5 Typ nicht eingeschränkt

invoice Typ nicht eingeschränkt erforderlich

minItems: 1

Variante 6 Typ nicht eingeschränkt

admin Typ nicht eingeschränkt erforderlich

minItems: 1

Variante 7 Typ nicht eingeschränkt

promotioncode Typ nicht eingeschränkt erforderlich

minItems: 1

Zusätzliche Felder sind in diesem Teilschema ausgeschlossen.

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

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "data": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "type": {
              "type": [
                "string",
                "number",
                "boolean",
                "null",
                "array",
                "object"
              ],
              "description": "Bei Erstellung immer 2 (manuelle Notiz), unabhängig vom Eingabewert; bei Änderung numerische Umwandlung.",
              "examples": [
                2
              ]
            },
            "subject": {
              "type": [
                "string",
                "number",
                "boolean",
                "null",
                "array",
                "object"
              ],
              "description": "Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 250 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.",
              "examples": [
                "Rückfrage zum Kurs"
              ]
            },
            "message": {
              "type": [
                "string",
                "number",
                "boolean",
                "null",
                "array",
                "object"
              ],
              "description": "Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 1000 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.",
              "examples": [
                "Bitte telefonisch melden."
              ]
            },
            "todo": {
              "type": [
                "string",
                "number",
                "boolean",
                "null",
                "array",
                "object"
              ],
              "description": "Wird nach PHP-Wahrheitswert zu true/false normalisiert; boolesche JSON-Werte verwenden.",
              "examples": [
                true
              ]
            },
            "pinned": {
              "type": "object",
              "properties": {
                "user": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                  }
                },
                "offer": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                  }
                },
                "category": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^category_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                  }
                },
                "booking": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                  }
                },
                "invoice": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                  }
                },
                "admin": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^admin_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                  }
                },
                "promotioncode": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^promotioncode_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                  }
                }
              },
              "additionalProperties": false,
              "anyOf": [
                {
                  "required": [
                    "user"
                  ],
                  "properties": {
                    "user": {
                      "minItems": 1
                    }
                  }
                },
                {
                  "required": [
                    "offer"
                  ],
                  "properties": {
                    "offer": {
                      "minItems": 1
                    }
                  }
                },
                {
                  "required": [
                    "category"
                  ],
                  "properties": {
                    "category": {
                      "minItems": 1
                    }
                  }
                },
                {
                  "required": [
                    "booking"
                  ],
                  "properties": {
                    "booking": {
                      "minItems": 1
                    }
                  }
                },
                {
                  "required": [
                    "invoice"
                  ],
                  "properties": {
                    "invoice": {
                      "minItems": 1
                    }
                  }
                },
                {
                  "required": [
                    "admin"
                  ],
                  "properties": {
                    "admin": {
                      "minItems": 1
                    }
                  }
                },
                {
                  "required": [
                    "promotioncode"
                  ],
                  "properties": {
                    "promotioncode": {
                      "minItems": 1
                    }
                  }
                }
              ],
              "description": "Connects a note to account-owned resources using their public v2 IDs.\nPin relation hooks apply changes separately from the storage getter.\n\nVerknüpft die Notiz mit vorhandenen Objekten desselben Kontos. Die Schlüssel user, offer, category, booking, invoice, admin und promotioncode enthalten jeweils Listen passender öffentlicher v2-IDs; Roh-DB-IDs, fremde Objekte und unbekannte Pin-Typen werden abgelehnt. Beim Anlegen und beim Ersetzen der Verknüpfungen muss mindestens eine gültige Referenz erhalten bleiben. Die Beziehungshooks speichern die Verknüpfungen getrennt vom normalen Feldsetter; ein Update von pinned ersetzt die vorherige Auswahl, während ein fehlendes pinned die Verknüpfungen unverändert lässt."
            }
          },
          "additionalProperties": true,
          "required": [
            "subject",
            "pinned"
          ]
        },
        {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": [
                  "string",
                  "number",
                  "boolean",
                  "null",
                  "array",
                  "object"
                ],
                "description": "Bei Erstellung immer 2 (manuelle Notiz), unabhängig vom Eingabewert; bei Änderung numerische Umwandlung.",
                "examples": [
                  2
                ]
              },
              "subject": {
                "type": [
                  "string",
                  "number",
                  "boolean",
                  "null",
                  "array",
                  "object"
                ],
                "description": "Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 250 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.",
                "examples": [
                  "Rückfrage zum Kurs"
                ]
              },
              "message": {
                "type": [
                  "string",
                  "number",
                  "boolean",
                  "null",
                  "array",
                  "object"
                ],
                "description": "Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 1000 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.",
                "examples": [
                  "Bitte telefonisch melden."
                ]
              },
              "todo": {
                "type": [
                  "string",
                  "number",
                  "boolean",
                  "null",
                  "array",
                  "object"
                ],
                "description": "Wird nach PHP-Wahrheitswert zu true/false normalisiert; boolesche JSON-Werte verwenden.",
                "examples": [
                  true
                ]
              },
              "pinned": {
                "type": "object",
                "properties": {
                  "user": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                    }
                  },
                  "offer": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                    }
                  },
                  "category": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "pattern": "^category_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                    }
                  },
                  "booking": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                    }
                  },
                  "invoice": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                    }
                  },
                  "admin": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "pattern": "^admin_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                    }
                  },
                  "promotioncode": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "pattern": "^promotioncode_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                    }
                  }
                },
                "additionalProperties": false,
                "anyOf": [
                  {
                    "required": [
                      "user"
                    ],
                    "properties": {
                      "user": {
                        "minItems": 1
                      }
                    }
                  },
                  {
                    "required": [
                      "offer"
                    ],
                    "properties": {
                      "offer": {
                        "minItems": 1
                      }
                    }
                  },
                  {
                    "required": [
                      "category"
                    ],
                    "properties": {
                      "category": {
                        "minItems": 1
                      }
                    }
                  },
                  {
                    "required": [
                      "booking"
                    ],
                    "properties": {
                      "booking": {
                        "minItems": 1
                      }
                    }
                  },
                  {
                    "required": [
                      "invoice"
                    ],
                    "properties": {
                      "invoice": {
                        "minItems": 1
                      }
                    }
                  },
                  {
                    "required": [
                      "admin"
                    ],
                    "properties": {
                      "admin": {
                        "minItems": 1
                      }
                    }
                  },
                  {
                    "required": [
                      "promotioncode"
                    ],
                    "properties": {
                      "promotioncode": {
                        "minItems": 1
                      }
                    }
                  }
                ],
                "description": "Connects a note to account-owned resources using their public v2 IDs.\nPin relation hooks apply changes separately from the storage getter.\n\nVerknüpft die Notiz mit vorhandenen Objekten desselben Kontos. Die Schlüssel user, offer, category, booking, invoice, admin und promotioncode enthalten jeweils Listen passender öffentlicher v2-IDs; Roh-DB-IDs, fremde Objekte und unbekannte Pin-Typen werden abgelehnt. Beim Anlegen und beim Ersetzen der Verknüpfungen muss mindestens eine gültige Referenz erhalten bleiben. Die Beziehungshooks speichern die Verknüpfungen getrennt vom normalen Feldsetter; ein Update von pinned ersetzt die vorherige Auswahl, während ein fehlendes pinned die Verknüpfungen unverändert lässt."
              }
            },
            "additionalProperties": true,
            "required": [
              "subject",
              "pinned"
            ]
          },
          "minItems": 1,
          "maxItems": 100
        }
      ]
    }
  },
  "additionalProperties": true,
  "required": [
    "data"
  ]
}

Notiz anlegen

{
  "data": {
    "subject": "Rückfrage zum Kurs",
    "message": "Bitte telefonisch melden.",
    "todo": true,
    "pinned": {
      "offer": [
        "offer_012345abcdef_123456"
      ]
    }
  }
}

Antworten

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

200application/json

data.id enthält die neue öffentliche ID oder beim Batch eine Liste; insert zeigt das Ergebnis.

Response Header

`X-Edoobox-Revision`

Rotated account revision supplied for the next action in one reviewed sequence.

string

pattern: "^[a-f0-9]{32}$"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$"
}

`application/json`

object

success boolean

error boolean | string

error_code string

data object

id Typ nicht eingeschränkt erforderlich

anyOf · Mindestens eine Variante muss passen

Variante 1 string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

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

Variante 2 array

Array-Elemente

string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

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

Variante 3 null

insert boolean erforderlich

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": {
      "type": "object",
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^note_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
            },
            {
              "type": "array",
              "items": {
                "type": "string",
                "pattern": "^note_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "insert": {
          "type": "boolean"
        }
      },
      "additionalProperties": true,
      "required": [
        "id",
        "insert"
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "id": "note_012345abcdef_123456",
    "insert": true
  }
}

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"
}

409application/json

The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.

`application/json`

object

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

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED40901",
  "error_code": "mutation_revision_conflict"
}

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"
}

503application/json

The account mutation lock or revision store is unavailable. No unprotected fallback is executed.

Response Header

`application/json`

object

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

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED50301",
  "error_code": "mutation_revision_busy"
}

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Note.php:210postNote()

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

true

x-edoobox-runtimeMutationGuard

true

x-edoobox-documentationReview

{
  "file": "docs/openapi/operation-contracts/09-messages-ai.json",
  "notes": []
}

x-edoobox-source

{
  "file": "application/models/v2/Note.php",
  "method": "postNote",
  "line": 210
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

false

x-edoobox-safeForAutomation

false

x-edoobox-permission

{
  "resource": "note",
  "short": "note",
  "checkedByDispatcher": true,
  "levels": [
    2,
    3,
    4
  ],
  "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}

Vollständige Operation als JSON

{
  "operationId": "post_v2_note",
  "summary": "Notiz anlegen",
  "description": "Erstellt eine manuelle Notiz (type wird serverseitig auf 2 gesetzt) und verknüpft sie mit mindestens einem vorhandenen, kontoeigenen Objekt in pinned. Nur die dokumentierten Pin-Typen sind erlaubt; Werte sind Listen öffentlicher v2-IDs. Bei todo=true entsteht eine offene Aufgabe. data erlaubt ein einzelnes Objekt oder höchstens 100 Objekte als Batch; die Antwort enthält eine ID bzw. eine ID-Liste.",
  "tags": [
    "note"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    },
    {
      "name": "X-Edoobox-If-Revision",
      "in": "header",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-f0-9]{32}$",
        "examples": [
          "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        ]
      },
      "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review."
    }
  ],
  "responses": {
    "200": {
      "description": "data.id enthält die neue öffentliche ID oder beim Batch eine Liste; insert zeigt das Ergebnis.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "id": "note_012345abcdef_123456",
              "insert": true
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "id": {
                    "anyOf": [
                      {
                        "type": "string",
                        "pattern": "^note_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                      },
                      {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "pattern": "^note_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                        }
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "insert": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": true,
                "required": [
                  "id",
                  "insert"
                ]
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "headers": {
        "X-Edoobox-Revision": {
          "schema": {
            "type": "string",
            "pattern": "^[a-f0-9]{32}$"
          },
          "description": "Rotated account revision supplied for the next action in one reviewed sequence."
        }
      }
    },
    "400": {
      "description": "Invalid request.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40006"
          }
        }
      }
    },
    "401": {
      "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40103"
          }
        }
      }
    },
    "402": {
      "description": "Missing/invalid action data or subscription/operation restriction.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80100"
          }
        }
      }
    },
    "403": {
      "description": "Permission denied. Browser CORS rejection may have an empty body.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40340"
          }
        }
      }
    },
    "404": {
      "description": "Unknown resource/action or unsupported method.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80019"
          }
        }
      }
    },
    "409": {
      "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED40901",
            "error_code": "mutation_revision_conflict"
          }
        }
      }
    },
    "422": {
      "description": "Validation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80020"
          }
        }
      }
    },
    "429": {
      "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED42902"
          }
        }
      },
      "headers": {
        "Retry-After": {
          "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
          "schema": {
            "type": "string",
            "examples": [
              "30"
            ]
          }
        }
      }
    },
    "502": {
      "description": "Server-side operation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED50201"
          }
        }
      }
    },
    "503": {
      "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "const": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED50301",
            "error_code": "mutation_revision_busy"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": true,
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "data": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": [
                        "string",
                        "number",
                        "boolean",
                        "null",
                        "array",
                        "object"
                      ],
                      "description": "Bei Erstellung immer 2 (manuelle Notiz), unabhängig vom Eingabewert; bei Änderung numerische Umwandlung.",
                      "examples": [
                        2
                      ]
                    },
                    "subject": {
                      "type": [
                        "string",
                        "number",
                        "boolean",
                        "null",
                        "array",
                        "object"
                      ],
                      "description": "Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 250 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.",
                      "examples": [
                        "Rückfrage zum Kurs"
                      ]
                    },
                    "message": {
                      "type": [
                        "string",
                        "number",
                        "boolean",
                        "null",
                        "array",
                        "object"
                      ],
                      "description": "Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 1000 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.",
                      "examples": [
                        "Bitte telefonisch melden."
                      ]
                    },
                    "todo": {
                      "type": [
                        "string",
                        "number",
                        "boolean",
                        "null",
                        "array",
                        "object"
                      ],
                      "description": "Wird nach PHP-Wahrheitswert zu true/false normalisiert; boolesche JSON-Werte verwenden.",
                      "examples": [
                        true
                      ]
                    },
                    "pinned": {
                      "type": "object",
                      "properties": {
                        "user": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                            "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                          }
                        },
                        "offer": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                            "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                          }
                        },
                        "category": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "pattern": "^category_[a-f0-9]{12}_-?[0-9]+$",
                            "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                          }
                        },
                        "booking": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$",
                            "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                          }
                        },
                        "invoice": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
                            "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                          }
                        },
                        "admin": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "pattern": "^admin_[a-f0-9]{12}_-?[0-9]+$",
                            "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                          }
                        },
                        "promotioncode": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "pattern": "^promotioncode_[a-f0-9]{12}_-?[0-9]+$",
                            "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                          }
                        }
                      },
                      "additionalProperties": false,
                      "anyOf": [
                        {
                          "required": [
                            "user"
                          ],
                          "properties": {
                            "user": {
                              "minItems": 1
                            }
                          }
                        },
                        {
                          "required": [
                            "offer"
                          ],
                          "properties": {
                            "offer": {
                              "minItems": 1
                            }
                          }
                        },
                        {
                          "required": [
                            "category"
                          ],
                          "properties": {
                            "category": {
                              "minItems": 1
                            }
                          }
                        },
                        {
                          "required": [
                            "booking"
                          ],
                          "properties": {
                            "booking": {
                              "minItems": 1
                            }
                          }
                        },
                        {
                          "required": [
                            "invoice"
                          ],
                          "properties": {
                            "invoice": {
                              "minItems": 1
                            }
                          }
                        },
                        {
                          "required": [
                            "admin"
                          ],
                          "properties": {
                            "admin": {
                              "minItems": 1
                            }
                          }
                        },
                        {
                          "required": [
                            "promotioncode"
                          ],
                          "properties": {
                            "promotioncode": {
                              "minItems": 1
                            }
                          }
                        }
                      ],
                      "description": "Connects a note to account-owned resources using their public v2 IDs.\nPin relation hooks apply changes separately from the storage getter.\n\nVerknüpft die Notiz mit vorhandenen Objekten desselben Kontos. Die Schlüssel user, offer, category, booking, invoice, admin und promotioncode enthalten jeweils Listen passender öffentlicher v2-IDs; Roh-DB-IDs, fremde Objekte und unbekannte Pin-Typen werden abgelehnt. Beim Anlegen und beim Ersetzen der Verknüpfungen muss mindestens eine gültige Referenz erhalten bleiben. Die Beziehungshooks speichern die Verknüpfungen getrennt vom normalen Feldsetter; ein Update von pinned ersetzt die vorherige Auswahl, während ein fehlendes pinned die Verknüpfungen unverändert lässt."
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "subject",
                    "pinned"
                  ]
                },
                {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "type": {
                        "type": [
                          "string",
                          "number",
                          "boolean",
                          "null",
                          "array",
                          "object"
                        ],
                        "description": "Bei Erstellung immer 2 (manuelle Notiz), unabhängig vom Eingabewert; bei Änderung numerische Umwandlung.",
                        "examples": [
                          2
                        ]
                      },
                      "subject": {
                        "type": [
                          "string",
                          "number",
                          "boolean",
                          "null",
                          "array",
                          "object"
                        ],
                        "description": "Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 250 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.",
                        "examples": [
                          "Rückfrage zum Kurs"
                        ]
                      },
                      "message": {
                        "type": [
                          "string",
                          "number",
                          "boolean",
                          "null",
                          "array",
                          "object"
                        ],
                        "description": "Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 1000 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.",
                        "examples": [
                          "Bitte telefonisch melden."
                        ]
                      },
                      "todo": {
                        "type": [
                          "string",
                          "number",
                          "boolean",
                          "null",
                          "array",
                          "object"
                        ],
                        "description": "Wird nach PHP-Wahrheitswert zu true/false normalisiert; boolesche JSON-Werte verwenden.",
                        "examples": [
                          true
                        ]
                      },
                      "pinned": {
                        "type": "object",
                        "properties": {
                          "user": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                            }
                          },
                          "offer": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                            }
                          },
                          "category": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "pattern": "^category_[a-f0-9]{12}_-?[0-9]+$",
                              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                            }
                          },
                          "booking": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$",
                              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                            }
                          },
                          "invoice": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
                              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                            }
                          },
                          "admin": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "pattern": "^admin_[a-f0-9]{12}_-?[0-9]+$",
                              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                            }
                          },
                          "promotioncode": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "pattern": "^promotioncode_[a-f0-9]{12}_-?[0-9]+$",
                              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                            }
                          }
                        },
                        "additionalProperties": false,
                        "anyOf": [
                          {
                            "required": [
                              "user"
                            ],
                            "properties": {
                              "user": {
                                "minItems": 1
                              }
                            }
                          },
                          {
                            "required": [
                              "offer"
                            ],
                            "properties": {
                              "offer": {
                                "minItems": 1
                              }
                            }
                          },
                          {
                            "required": [
                              "category"
                            ],
                            "properties": {
                              "category": {
                                "minItems": 1
                              }
                            }
                          },
                          {
                            "required": [
                              "booking"
                            ],
                            "properties": {
                              "booking": {
                                "minItems": 1
                              }
                            }
                          },
                          {
                            "required": [
                              "invoice"
                            ],
                            "properties": {
                              "invoice": {
                                "minItems": 1
                              }
                            }
                          },
                          {
                            "required": [
                              "admin"
                            ],
                            "properties": {
                              "admin": {
                                "minItems": 1
                              }
                            }
                          },
                          {
                            "required": [
                              "promotioncode"
                            ],
                            "properties": {
                              "promotioncode": {
                                "minItems": 1
                              }
                            }
                          }
                        ],
                        "description": "Connects a note to account-owned resources using their public v2 IDs.\nPin relation hooks apply changes separately from the storage getter.\n\nVerknüpft die Notiz mit vorhandenen Objekten desselben Kontos. Die Schlüssel user, offer, category, booking, invoice, admin und promotioncode enthalten jeweils Listen passender öffentlicher v2-IDs; Roh-DB-IDs, fremde Objekte und unbekannte Pin-Typen werden abgelehnt. Beim Anlegen und beim Ersetzen der Verknüpfungen muss mindestens eine gültige Referenz erhalten bleiben. Die Beziehungshooks speichern die Verknüpfungen getrennt vom normalen Feldsetter; ein Update von pinned ersetzt die vorherige Auswahl, während ein fehlendes pinned die Verknüpfungen unverändert lässt."
                      }
                    },
                    "additionalProperties": true,
                    "required": [
                      "subject",
                      "pinned"
                    ]
                  },
                  "minItems": 1,
                  "maxItems": 100
                }
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data"
          ]
        },
        "examples": {
          "request": {
            "summary": "Notiz anlegen",
            "value": {
              "data": {
                "subject": "Rückfrage zum Kurs",
                "message": "Bitte telefonisch melden.",
                "todo": true,
                "pinned": {
                  "offer": [
                    "offer_012345abcdef_123456"
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/09-messages-ai.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Note.php",
    "method": "postNote",
    "line": 210
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "note",
    "short": "note",
    "checkedByDispatcher": true,
    "levels": [
      2,
      3,
      4
    ],
    "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
  }
}

Aufruf vorbereiten

Beispiel

Platzhalter ersetzen und Vertragsangaben prüfen. Die Beispiele werden hier nicht ausgeführt.

cURL

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
cat > payload.json <<'EDOOBOX_JSON_EXAMPLE'
{
  "data": {
    "subject": "Rückfrage zum Kurs",
    "message": "Bitte telefonisch melden.",
    "todo": true,
    "pinned": {
      "offer": [
        "offer_012345abcdef_123456"
      ]
    }
  }
}
EDOOBOX_JSON_EXAMPLE
curl --request 'POST' \
  --url "${API_ORIGIN%/}"'/v2/note' \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" \
  --header 'Content-Type: application/json' \
  --data-binary '@payload.json'

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/note";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "subject": "Rückfrage zum Kurs",
    "message": "Bitte telefonisch melden.",
    "todo": true,
    "pinned": {
      "offer": [
        "offer_012345abcdef_123456"
      ]
    }
  }
});
const response = await fetch(url, { method: "POST", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/note"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"subject\":\"Rückfrage zum Kurs\",\"message\":\"Bitte telefonisch melden.\",\"todo\":true,\"pinned\":{\"offer\":[\"offer_012345abcdef_123456\"]}}}".encode("utf-8")

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="POST", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Ohne JavaScript können Sie die weiteren Aufrufbeispiele hier aufklappen und den Code manuell kopieren.

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/note";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "subject": "Rückfrage zum Kurs",
    "message": "Bitte telefonisch melden.",
    "todo": true,
    "pinned": {
      "offer": [
        "offer_012345abcdef_123456"
      ]
    }
  }
});
const response = await fetch(url, { method: "POST", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/note"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"subject\":\"Rückfrage zum Kurs\",\"message\":\"Bitte telefonisch melden.\",\"todo\":true,\"pinned\":{\"offer\":[\"offer_012345abcdef_123456\"]}}}".encode("utf-8")

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="POST", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Server aus der Spezifikation

https://app2.edoobox.com

edoobox API

Verwenden Sie die für Ihre Integration bestätigte API-Basis-URL. Ein lokaler Entwicklungsserver ist keine Produktionsadresse.

Als Markdown lesenEin Endpunkt. Vollständig. Für Menschen und LLM.