EntwicklerAPI-Ressourcen

Kommentare

Kommentare sind die Unterhaltung, die das Admin-Panel neben einem Datensatz zeigt: Notizen, die Admins füreinander hinterlassen, und Nachrichten an Veranstalter:innen oder Familien. In der API ist ein Kommentar ein comment. Er kann an ein Angebot, eine Anmeldung, eine Teilnehmer:in, ein Konto, eine Veranstalter:in oder eine Saison gehängt werden.

Endpunkte

GET/{records}/{uuid}/commentsDie Kommentare eines Datensatzes abrufen
GET/comments/{uuid}Einen Kommentar abrufen
POST/{records}/{uuid}/commentsEinen Kommentar hinzufügen

Das Modell des Kommentars

Name
uuid
Typ
string
Beschreibung
Die Kennung des Kommentars.
Name
subjectType
Typ
string
Beschreibung
Die Art des Datensatzes, zu dem der Kommentar gehört: offer, attendance, participant, account, host oder edition.
Name
subject
Typ
string
Beschreibung
Die UUID dieses Datensatzes.
Name
body
Typ
string
Beschreibung
Der Text in Markdown: fett, kursiv, Listen und Links. Bei Antworten, die per E-Mail eingegangen sind, ist es der reine Text der E-Mail.
Name
channel
Typ
string
Beschreibung
app für Kommentare, die im Admin-Panel oder über die API geschrieben wurden, email für Antworten, die per E-Mail eingegangen sind.
Name
visibility
Typ
string
Beschreibung
internal, wenn nur Admins den Kommentar lesen, shared, wenn auch andere ihn lesen: Er wurde an eine Veranstalter:in oder die Familie gesendet, er wurde von einer Veranstalter:in geschrieben, oder er antwortet auf einen Kommentar, der an eine Veranstalter:in gesendet oder von einer Veranstalter:in geschrieben wurde.
Name
author
Typ
reference
Beschreibung
Das Konto der Person, die den Kommentar geschrieben hat.
Name
authorName
Typ
string
Beschreibung
Wer den Kommentar geschrieben hat, wenn es keine Person mit Konto war: die Absender:in einer E-Mail-Antwort oder ein Service-Account.
Name
parent
Typ
string
Beschreibung
Die UUID des Kommentars, auf den dieser antwortet.
Name
replies
Typ
string[]
Beschreibung
Die UUIDs der Antworten auf diesen Kommentar.
Name
createdAt
Typ
timestamp
Beschreibung
Wann der Kommentar geschrieben wurde.
Name
editedAt
Typ
timestamp
Beschreibung
Wann der Kommentar zuletzt bearbeitet wurde.

Wo Kommentare liegen

Kommentare lesen und schreiben Sie über den Datensatz, zu dem sie gehören. Jede Art von Datensatz braucht ihre eigene Rolle:

Datensatz	Pfad	Erfordert
Angebot	`/offers/{uuid}/comments`	`ROLE_HOST`
Anmeldung	`/attendances/{uuid}/comments`	`ROLE_HOST`
Teilnehmer:in	`/participants/{uuid}/comments`	`ROLE_PARTICIPANTS_ADMIN` und `ROLE_ADMIN`
Konto	`/accounts/{uuid}/comments`	`ROLE_ADMIN`
Veranstalter:in	`/hosts/{uuid}/comments`	`ROLE_ADMIN`
Saison	`/editions/{uuid}/comments`	`ROLE_ADMIN`

Sie sehen die Kommentare, die das Admin-Panel Ihnen an diesem Datensatz zeigen würde. Admins sehen alle. Veranstalter:innen sehen nur die Kommentare, die sie selbst geschrieben haben oder die an eine Veranstalter:in gerichtet waren, deren Mitglied sie sind, samt den Antworten darauf. Ein Service-Account, der weder ROLE_ADMIN noch ROLE_PARTICIPANTS_ADMIN hat, sieht keine.

Bei Veranstalter:innen folgen die Kommentare zu einer Anmeldung der Anmeldung: Sie erreichen sie nur für die Anmeldungen, die ihre Teilnahmeliste ihnen zeigt.

GET/{records}/{uuid}/comments

Die Kommentare eines Datensatzes abrufen

Liefert alle Kommentare zu einem Datensatz. Die Liste ist nicht paginiert.

Ersetzen Sie {records} durch offers, attendances, participants, accounts, hosts oder editions und {uuid} durch die UUID des Datensatzes. Ein Datensatz, den Sie nicht sehen dürfen, ist ein 404.

GET/accounts/{uuid}/comments

curl https://example.fepli.eu/api/accounts/0191c7b2-4d5e-7f60-8a1b-2c3d4e5f6a05/comments \
  -H "Authorization: Bearer $FEPLI_TOKEN"

Antwort

[
  {
    "uuid": "0192f3a4-5b6c-7d7e-8f9a-0b1c2d3e4f33",
    "subjectType": "account",
    "subject": "0191c7b2-4d5e-7f60-8a1b-2c3d4e5f6a05",
    "body": "Familie hat angerufen: Zahlung erfolgt bar am Montag.",
    "channel": "app",
    "visibility": "internal",
    "author": {
      "uuid": "0190a1b2-c3d4-7e5f-8a6b-7c8d9e0f1a22",
      "name": "Sabine Krüger"
    },
    "replies": ["0192f3b5-6c7d-7e8f-9a0b-1c2d3e4f5a34"],
    "createdAt": "2026-09-08T14:12:09+02:00"
  },
  {
    "uuid": "0192f3b5-6c7d-7e8f-9a0b-1c2d3e4f5a34",
    "subjectType": "account",
    "subject": "0191c7b2-4d5e-7f60-8a1b-2c3d4e5f6a05",
    "body": "Zahlung ist eingegangen, Beleg RE-142.",
    "channel": "app",
    "visibility": "internal",
    "authorName": "Support-Agent",
    "parent": "0192f3a4-5b6c-7d7e-8f9a-0b1c2d3e4f33",
    "replies": [],
    "createdAt": "2026-09-10T10:23:40+02:00"
  }
]

GET/comments/{uuid}

Einen Kommentar abrufen

Liefert einen Kommentar. Erfordert ROLE_ADMIN.

GET/comments/{uuid}

curl https://example.fepli.eu/api/comments/0192f3a4-5b6c-7d7e-8f9a-0b1c2d3e4f33 \
  -H "Authorization: Bearer $FEPLI_TOKEN"

POST/{records}/{uuid}/comments

Einen Kommentar hinzufügen

Fügt einem Datensatz einen Kommentar hinzu. Kommentare, die Admins und Service-Accounts über die API schreiben, sind interne Notizen: Nur Admins lesen sie. Nachrichten an Veranstalter:innen oder Familien schreiben Sie im Admin-Panel. Ein Kommentar, den eine Veranstalter:in schreibt, ist shared, weil Veranstalter:innen lesen, was sie geschrieben haben.

Der Kommentar wird mit dem Namen der Person oder des Service-Accounts hinter dem Token unterschrieben.

Pflichtattribute

Name
body
Typ
string
Beschreibung
Der Text in Markdown (fett, kursiv, Listen, Links), bis zu 10.000 Zeichen. Das Admin-Panel und die E-Mail an die benachrichtigten Personen zeigen ihn formatiert. Rohes HTML wird weggelassen.

Optionale Attribute

Name
parent
Typ
string
Beschreibung
Die UUID eines Kommentars am selben Datensatz, auf den Sie antworten. Veranstalter:innen lesen die Antworten auf einen Kommentar, der an eine Veranstalter:in gesendet oder von einer Veranstalter:in geschrieben wurde. Admins und Service-Accounts können auf einen solchen Kommentar deshalb nicht antworten (422). Senden Sie die Notiz stattdessen als neuen Kommentar oder antworten Sie der Veranstalter:in im Admin-Panel.
Name
notify
Typ
boolean
Beschreibung
Ob die Admins benachrichtigt werden. Der Standard ist true: Jeder Admin erhält eine Benachrichtigung im Admin-Panel, und Admins mit notifyComments erhalten außerdem eine E-Mail. Senden Sie false, um den Kommentar hinzuzufügen, ohne jemanden zu benachrichtigen.

POST/attendances/{uuid}/comments

curl -X POST https://example.fepli.eu/api/attendances/0192d0e8-3a4b-7c5d-9e6f-7a8b9c0d1e07/comments \
  -H "Authorization: Bearer $FEPLI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"body": "Lena braucht am Mittwoch ein Leihrad."}'

Die Antwort (201 Created) enthält den neuen Kommentar.