API-Dokumentation
Willkommen zur API-Dokumentation der Stift Keppel Vertretungsplan API. Diese API ermöglicht es, aktuelle Vertretungspläne für verschiedene Klassen und Tage abzurufen.
Grundlegende Nutzung
Um die Vertretungsdaten für einen bestimmten Tag abzurufen, hängen Sie das gewünschte Datum im Format
DD-MM-YYYY
an die URL an:
http://stiftkeppel.sknif.de/api/vertretung.php?datum=16-01-2025
Filter nach Klasse
Sie können die Ergebnisse auf eine bestimmte Klasse beschränken, indem Sie den Parameter
&klasse=
hinzufügen:
http://stiftkeppel.sknif.de/api/vertretung.php?datum=16-01-2025&klasse=10B
Exactes Datum bekommen
Die API sucht wenn der an dem Tag ein Freier Tag ist die nächst möglichen daten für den folgenden Tag. Wenn man
&Exect=true
hinzufügt wird nur dann was ausgegeben wenn dieser Tag kein Freiert Tag ist:
http://stiftkeppel.sknif.de/api/vertretung.php?datum=16-01-2025&Exect=true
Filter nach Lehrer
Zusätzlich können Sie die Ergebnisse nach einem bestimmten Lehrer filtern, indem Sie den Parameter
&lehrer=
hinzufügen:
http://stiftkeppel.sknif.de/api/vertretung.php?datum=16-01-2025&lehrer=MOC
Sortierung
Die Ergebnisse können nach verschiedenen Kriterien sortiert werden, indem Sie den Parameter
&sort=
verwenden:
sort=lehrer
: Sortiert die Ergebnisse nach dem Lehrer.sort=klasse
: Sortiert die Ergebnisse nach der Klasse.sort=fach
: Sortiert die Ergebnisse nach dem Fach.sort=raum
: Sortiert die Ergebnisse nach dem Raum. (BETA)sort=time
: Standardmäßig werden die Ergebnisse nach der Zeit sortiert.
http://stiftkeppel.sknif.de/api/vertretung.php?datum=16-01-2025&sort=lehrer
Zeitraum-Offset
Um Daten für mehrere Tage ab dem angegebenen Datum anzuzeigen, nutzen Sie den &offset=
Parameter:
http://stiftkeppel.sknif.de/api/vertretung.php?datum=16-01-2025&offset=1
Die Daten stammen von Web Untis und werden von der Schule verwaltet. Diese API dient ausschließlich zum Abrufen der Vertretungsdaten.