REST API Dokumentation
Empfehlung: Verwenden Sie API v2.1 für neue Integrationen. Die v2.0 API ist veraltet und wird nur noch aus Kompatibilitätsgründen unterstützt.
API v2.1 (Empfohlen)
Die API v2.1 bietet eine klare Struktur mit dedizierten Endpunkten für jeden Standorttyp. Dies verhindert Mehrdeutigkeiten, wenn mehrere Standorte denselben Slug haben (z.B. "Hessen" als Bundesland und als Stadt).
Verfügbare Endpunkte
Standorttyp | Basis-URL | Verfügbare Aktionen |
---|---|---|
Bundesländer | /api/v2.1/federal-states | Liste, Details, Ferien, iCalendar |
Städte | /api/v2.1/cities | Liste, Details, Ferien, iCalendar |
Landkreise | /api/v2.1/counties | Liste, Details, Ferien, iCalendar |
Schulen | /api/v2.1/schools | Liste, Details, Ferien, iCalendar, vCard |
Beispiele: Standorte abrufen
-
Alle Bundesländer:
curl -H "Accept: application/json" https://www.mehr-schulferien.de/api/v2.1/federal-states
-
Spezifisches Bundesland:
curl -H "Accept: application/json" https://www.mehr-schulferien.de/api/v2.1/federal-states/hessen
-
Alle Städte:
curl -H "Accept: application/json" https://www.mehr-schulferien.de/api/v2.1/cities
Beispiele: Feriendaten abrufen
-
Ferien für ein Bundesland:
curl -H "Accept: application/json" https://www.mehr-schulferien.de/api/v2.1/federal-states/bayern/periods?start_date=2024-01-01&end_date=2024-12-31
-
Nur Schulferien für eine Stadt:
curl -H "Accept: application/json" https://www.mehr-schulferien.de/api/v2.1/cities/muenchen/periods?type=vacation&start_date=2024-01-01&end_date=2024-12-31
-
Nur Feiertage für einen Landkreis:
curl -H "Accept: application/json" https://www.mehr-schulferien.de/api/v2.1/counties/muenchen-landkreis/periods?type=holiday&start_date=2024-01-01&end_date=2024-12-31
iCalendar Export
Exportieren Sie Feriendaten im iCalendar-Format (.ics) für die direkte Integration in Kalenderanwendungen:
-
Schuljahr 2024/2025 für Bayern:
curl https://www.mehr-schulferien.de/api/v2.1/federal-states/bayern/icalendar?year=2024&vacation_types=school
-
Kalenderjahr 2024 für München (alle Ferien & Feiertage):
curl https://www.mehr-schulferien.de/api/v2.1/cities/muenchen/icalendar?year=2024&vacation_types=all&calendar_year=true
-
Nur Schulferien für eine spezifische Schule:
curl https://www.mehr-schulferien.de/api/v2.1/schools/gymnasium-muenchen-nord/icalendar?year=2024&vacation_types=school
vCard Export (nur für Schulen)
Exportieren Sie Schulkontaktdaten als vCard:
curl https://www.mehr-schulferien.de/api/v2.1/schools/gymnasium-muenchen-nord/vcard
API Response Format
Alle API v2.1 Antworten folgen einem einheitlichen JSON-Format:
{ "data": [ /* Array von Objekten oder einzelnes Objekt */ ], "meta": { "api_version": "2.1" } }
Query Parameter
Parameter | Endpunkte | Beschreibung |
---|---|---|
start_date | periods | Startdatum im Format YYYY-MM-DD |
end_date | periods | Enddatum im Format YYYY-MM-DD |
type | periods | vacation (nur Ferien) oder holiday (nur Feiertage) |
year | icalendar | Jahr für den Export (Standard: aktuelles Jahr) |
vacation_types | icalendar | school (nur Schulferien) oder all (alle) |
calendar_year | icalendar | true für Kalenderjahr, sonst Schuljahr |
Vollständige API v2.1 Dokumentation: API v2.1 Referenz auf GitHub
API v2.0 (Veraltet)
Hinweis: Die API v2.0 ist veraltet und wird nur noch aus Kompatibilitätsgründen unterstützt. Bitte verwenden Sie für neue Integrationen die API v2.1.
Locations
Das Model Locations wird für die Speicherung von Ländern, Bundesländern, Landkreisen, Städten und Schulen benutzt. Dabei werden die einzelnen Ebenen miteinander verknüpft.
-
Daten zu Deutschland abrufen:
curl -H "Content-Type: application/json" http://www.mehr-schulferien.de/api/v2.0/locations/1
-
Daten zu allen Locations abrufen:
curl -H "Content-Type: application/json" http://www.mehr-schulferien.de/api/v2.0/locations
Periods
Das Model Period wird zur Speicherung der einzelnen Ferien und Feiertage benutzt.
-
Daten zum Eintrag mit der ID 23 abrufen:
curl -H "Content-Type: application/json" http://www.mehr-schulferien.de/api/v2.0/periods/23
Holiday or Vacation Types
Das Model HolidayOrVacationType wird zur Speicherung der einzelnen Arten von Ferien und Feiertagen benutzt.
-
Daten zum Eintrag mit der ID 10 abrufen:
curl -H "Content-Type: application/json" http://www.mehr-schulferien.de/api/v2.0/holiday_or_vacation_types/10
Hallo, ich bin Stefan Wintermeyer! 👋
Gründer von mehr-schulferien.de
Ich freue mich sehr, dass Du die APIs und den MCP-Server nutzen möchtest!
Möchtest Du bei diesem Projekt mitmachen und helfen?
Danke schon mal an dieser Stelle! Hier sind drei Möglichkeiten:
- • Mit einem Link auf https://www.mehr-schulferien.de (diese Incoming Links sind sehr wichtig für SEO)
- • Benutze die Wiki Funktion, um die Daten zu verbessern. Fehlt bei einer Schule die Homepage URL oder die Telefonnummber? Dann hilf uns bitte damit, indem Du diese rausfindest und dann dem Datensatz hinzuzufügst. Das gleiche gilt für bewegliche Ferientage.
- • Helfe beim Programmieren von neuen Features oder beim Fixen von Bugs.
Habst Du Fragen oder einen Featurewunsch?
Schreib mir eine E-Mail!
💡 Besonders interessiert bin ich an:
- • Deinen Anwendungsfällen und wie Du die Daten nutzt
- • Feature-Wünschen und Verbesserungsvorschlägen
- • Success Stories - zeige mir, was Du gebaust hast!
- • Bugs oder Probleme