Endpunkt checkstudent
Mit dem Endpunkt checkstudent können sie eine Notwendigkeits- & Zumutbarkeitsprüfung durchführen.
https://app.{instanz}.via-cloud.de/api/oepnv/checkstudent?Parameter
| Parameter | notwendig | Beschreibung |
|---|---|---|
| student | ✅ | Adresse des Schülers Beispiel: Königsbrücker Straße 96, 01187 Dresden |
| school | ✅ | Adresse der Schule Beispiel: Marienallee 12, 01099 Dresden |
| min_entfernung | ✅ | Mindestentfernung Fußweg, ab der eine ÖPNV-Beförderung notwendig wird in Metern.Beispiel: 2000 |
| max_schulwegezeit | Maximale Dauer des Schulwegs in Minuten. Standard: 120 Verfügbar: Integer | |
| max_haltestellenweg | Maximale Länge des Wegs von Zuhause zur Haltestelle plus von der Haltestelle zur Schule in Metern. Standard: 3000 Verfügbar: Integer | |
| max_wartezeit | Maximale Wartezeit an Haltestellen und Schule in Minuten. Standard: 60 Verfügbar: Integer | |
| min_startzeit | Früheste Startzeit als Uhrzeit.Standard: 05:00Verfügbar: String im Format hh:mm | |
| richtung | Festlegung ob Hinfahrt (Zuhause → Schule) oder Rückfahrt (Schule → Zuhause) Standard: 0 Verfügbar: 0 (Hinfahrt), 1 (Rückfahrt) | |
| api-key | ✅ | ihr API-Schlüssel ist für diese Schnittstelle immer notwendig. |
Ergebnis