Informationen für Entwickler
Das Open-Source-Projekt
mehr-schulferien.de ist ein mit der Programmiersprache Elixir und dem Phoenix Framework geschriebenes Open-Source-Projekt (MIT Lizenz). Der Code wird auf https://github.com/mehr-schulferien-de/www.mehr-schulferien.de gehostet und dort findet die Entwicklungsarbeit statt.
Wir freuen uns über gute Feature-Requests und Bug-Reports! Idealerweise als Issues auf Github, aber auch gerne per E-Mail an Stefan Wintermeyer (sw@wintermeyer-consulting.de)
URL-Parameter
Verschiedene Ansichten können über URL-Parameter angepasst werden. Die Ferienübersicht unter / unterstützt folgende Parameter:
| Parameter | Typ | Beschreibung | Beispiel |
|---|---|---|---|
| today | String | Startdatum im Format DD.MM.YYYY | today=01.09.2024 |
| days | Integer | Anzahl der anzuzeigenden Tage (1-365) | days=180 |
Beispiel mit kombinierten Parametern: /?today=01.09.2024&days=180
Weitere Informationen finden Sie in der Dokumentation auf GitHub.
Die API
Alle Daten können per RESTful JSON-API abgerufen werden. Stück für Stück werden wir hierzu die Dokumentation erweitern. Hier schon mal die Basics.
locations
Das Model Locations wird für die Speicherung von Ländern (countries), Bundesländern (federal_states), Landkreisen (counties), Städten (cities) und Schulen (schools) benutzt. Die Dabei werden die einzelnen Ebenen mit einander verknüpft.
Beispiel
- 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.
Beispiel
- Daten zum Eintrag mit der ID 23 abrufen:
curl -H "Content-Type: application/json" http://www.mehr-schulferien.de/api/v2.0/periods/23
- Daten zu allen Einträgen abrufen:
curl -H "Content-Type: application/json" http://www.mehr-schulferien.de/api/v2.0/periods
holiday_or_vacation_types
Das Model HolidayOrVacationType wird zur Speicherung der einzelnen Arten von Ferien und Feiertage benutzt.
Beispiel
- 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
- Daten zu allen Einträgen abrufen:
curl -H "Content-Type: application/json" http://www.mehr-schulferien.de/api/v2.0/holiday_or_vacation_types
Noch Wünsche an die API?
Mit der aktuellen API haben Sie Zugriff auf alle Daten, müssen diese aber noch selber verarbeiten. In Zukunft werden wir auch Anfragen wie "Ist heute ein Feiertag" per API beantworten. Wenn Sie dazu Wünsche oder Vorschläge haben, würden wir uns über ein entsprechendes Feature-Request-Issues auf Github freuen.