Kalender-Schnittstelle

Der Kalender-API-Endpunkt ermöglicht den Zugriff auf Veranstaltungsdaten über mehrere Programme hinweg. Diese Funktion muss zunächst auf Programmebene aktiviert werden.

Dies kann dazu benutzt werden um Kalender damit zu erstellen.

Aktivierung

1. Die API muss pro Programm aktiviert werden (Programm > Einstellungen > Allgemeines > Erweiterte Einstellungen)

2. Programme müssen die Sichtbarkeit "Mit Veranstaltungen" haben

3. Einzelne Veranstaltungen können nach Aktivierung der Option ausgeschlossen werden

Verwendung

Basis-URL: /api/events/calendar

Parameter

• programs: Kommagetrennte Liste von Programm-IDs (optional)

• start_date: Startdatum im Format YYYY-MM-DD (optional)

• end_date: Enddatum im Format YYYY-MM-DD (optional)

• fields: Kommagetrennte Liste der gewünschten Felder (optional)

Beispiele

• Alle Veranstaltungen von Programmen in denen die Option aktiv ist: /api/events/calendar

• Veranstaltungen eines oder mehreren bestimmten Programmen: /api/events/calendar?programs=42,43

• Veranstaltungen in einem Zeitraum: /api/events/calendar?start_date=2023-01-01&end_date=2023-12-31

• Nur bestimmte Felder: /api/events/calendar?fields=title,start,end

Hinweise

• Die Ergebnisse werden nach Startzeit, Endzeit und Veranstaltungsnummer sortiert

• Die Daten werden für 60 Sekunden zwischengespeichert

• Bei ungültigen Datumsformaten wird ein 400-Fehler zurückgegeben