--- url: /de/api/events.md description: >- Erstelle, lese, aktualisiere und lösche Events über die Add to Calendar PRO API für Kalender-Buttons und RSVP-Formulare. --- # Event-API ::: info Style = Layout Styles werrden auf API-Ebene als "layout" bezeichnet. ::: ## Alle Events listen ``` GET /event/all ``` Gibt eine Liste mit den IDs, Prokey und Label (auto-generierte Zusammenfassung) aller verfügbaren Events zurück. ``` GET /event/all?from=:timestamp&to=:timestamp&group=:group-prokey&dates=:boolean ``` Filtert die Ergebnisse optional nach Zeit und Gruppe. Benutze "from", "to", "group" - oder alle drei Parameter. Erlaubte Werte für Timestamps: * `now` (nutzt die aktuelle Server-Zeit). * Ein valider UTC ISO Datetime String ohne Millisekunden (Bsp.: `2025-11-03T20:06:27Z`) Ergänzt zusätzlich das Dates-Objekt je Eintrag, wenn der Query-Paramter `dates=true` gesetzt wird. ::: info Bei sich wiederholenden Events oder Event mit mehreren Terminen wird der früheste Start und das späteste Ende über alle Termine hinweg für die Filterung herangezogen. ::: ## Das neueste Event lesen ``` GET /event/latest ``` Gibt das neueste Event zurück. Id, Prokey, Label und optional das Dates-Objekt (sofern als Query-Paramerter gegeben; siehe oben). ## Ein Event lesen ``` GET /event/:prokey ``` Beim Abrufen eines Events sind keine zusätzlichen Parameter möglich. Es wird lediglich der prokey in der Anfrage-URL benötigt, um alle Daten für ein bestimmtes Element zu erhalten. ### Mögliche Response ```json { "status": "published", "dates": [ { "name": "Termin 1", "startDate": "2024-11-14", "endDate": null, "timeZone": "Europe/Berlin", "organizer_name": "", "organizer_email": "", "description": "

Eine kurze Beschreibung.

", "location": "Nirgends" }, { "name": "Termin 2", "startDate": "2024-11-15", "endDate": null, "timeZone": "Europe/Berlin", "organizer_name": "", "organizer_email": "" } ], "title_event_series": "Dummy Terminreihe", "simplified_recurrence": true, "recurrence": null, "recurrence_interval": null, "recurrence_count": null, "recurrence_byDay": null, "recurrence_byMonthDay": null, "recurrence_byMonth": null, "recurrence_weekstart": null, "recurrence_simple_type": null, "layout": null, "landingpage": null, "iCalFileName": null, "rsvp": false, "rsvp_block": null, "cta": true, "cta_block": 74, "hideButton": false, "distribution": true, "sequence": "10", "date_created": "2024-11-01T12:57:25.983Z", "date_updated": "2024-11-02T18:20:56.152Z", "event_group": "803a96ac-aaaa-2222-bbbb-6fb191041543", "prokey": "99ec3e7f-ef04-bbbb-a3d7-e30736faaaaa" } ``` ## Event erstellen ``` POST /event ``` Um ein neues Event zu erstellen, musst du mindestens die folgenden Felder im Body angeben: ```json { "event_group": "prokey-der-event-gruppe", // wird bei Erstellung einer Gruppe zurückgegeben; auch über die UI der Anwendung einsehbar "dates": [{ "name": "Titel des Termins", "startDate": "2024-12-24", "timeZone": "America/Los_Angeles" // nicht verpflichtend, aber strengstens empfohlen }], } ``` Anstelle der `event_group` kannst du auch `new_event_group_name` (einfacher String) nutzen. Dies erstellt eine neue Gruppe mit dem gegebenen Namen anstelle der Verknüpfung des Events mit einer bestehenden. Du kannst auch weitere Termine zu dem "dates"-Array hinzufügen (= Terminreihe). ::: warning Einschränkungen Beachte die Einschränkungen, die auch in der Anwendung gelten - wie die Tatsache, dass Wiederholungs-Regeln nicht mit mehreren Terminen kombinierbar sind, etc. Wir empfehlen ein potentielles Schema zunächst in der Anwendung zu erstellen, bevor du es über die API generierst. Weiterhin ist es nicht erlaubt, den Status eines Events über die API zu ändern. ::: ### Möglicher Request mit allen Feldern ```json { "event_group": "prokey-der-event-gruppe", "dates": [{ "name": "Titel des Termins", "description": "

Eine Event-Beschreibung

", // erlaubt

, , , ,

,

,

,

,