API von bedarfsverkehr.at/mobil-am-land.at: Unterschied zwischen den Versionen
Zeile 81: | Zeile 81: | ||
=== Liste aller Datenbankfelder === | === Liste aller Datenbankfelder === | ||
+ | |||
+ | ==== Datenbankfelder zum Betrieb ==== | ||
{| class="table table-bordered table-sm sortable" style="font-size:small" | {| class="table table-bordered table-sm sortable" style="font-size:small" | ||
|- | |- | ||
! Feld | ! Feld | ||
− | |||
! Kurzbeschreibung | ! Kurzbeschreibung | ||
|- | |- | ||
| aktiv | | aktiv | ||
− | |||
| ist der Bedarfsverkehr aktuell in Betrieb oder erst geplant bzw. eingestellt? (wahr/falsch) | | ist der Bedarfsverkehr aktuell in Betrieb oder erst geplant bzw. eingestellt? (wahr/falsch) | ||
|- | |- | ||
| App-Android | | App-Android | ||
− | |||
| URL zum Download der Android-App zur Buchung des Angebots | | URL zum Download der Android-App zur Buchung des Angebots | ||
|- | |- | ||
| App-iOS | | App-iOS | ||
− | |||
| URL zum Download der iOS-App zur Buchung des Angebots | | URL zum Download der iOS-App zur Buchung des Angebots | ||
|- | |- | ||
| Bestellnummer | | Bestellnummer | ||
− | |||
| Telefonnummer, unter der der Bedarfsverkehr bestellt werden kann | | Telefonnummer, unter der der Bedarfsverkehr bestellt werden kann | ||
|- | |- | ||
| Betreiberkonstellation | | Betreiberkonstellation | ||
− | |||
| mögliche Werte: | | mögliche Werte: | ||
*Verein mit bezahlten Fahrer*innen | *Verein mit bezahlten Fahrer*innen | ||
Zeile 114: | Zeile 110: | ||
*Bürgerbus (freiwillige Fahrer*innen im Fahrzeug eines Verkehrsunternehmens) | *Bürgerbus (freiwillige Fahrer*innen im Fahrzeug eines Verkehrsunternehmens) | ||
*Sonstiges | *Sonstiges | ||
− | |- | + | |-sform ''(deprecated)'' |
− | |||
− | |||
| ähnlich funktionierende Systeme werden als „Betriebsformen“ in Gruppen zusammengefasst (z.B. Anruf-Sammeltaxi, Rufbus, Gemeindebusse, Citytaxi etc.) | | ähnlich funktionierende Systeme werden als „Betriebsformen“ in Gruppen zusammengefasst (z.B. Anruf-Sammeltaxi, Rufbus, Gemeindebusse, Citytaxi etc.) | ||
− | |- | + | |-szeit |
− | |||
− | |||
| grobe Einteilung der Qualität der Betriebszeiten, mögliche Werte: | | grobe Einteilung der Qualität der Betriebszeiten, mögliche Werte: | ||
*24/7 | *24/7 | ||
Zeile 132: | Zeile 124: | ||
*nur an bestimmten Tagen | *nur an bestimmten Tagen | ||
*nur zu bestimmten Zeiten | *nur zu bestimmten Zeiten | ||
− | |- | + | |-szeitenszeiten in einem für Menschen lesbaren Format |
− | |||
− | |||
− | |||
|- | |- | ||
| Einschränkung | | Einschränkung | ||
− | |||
| hier wird vermerkt, wenn ein Angebot nur für eine bestimmte Zielgruppe (z.B. SeniorInnen, Vereinsmitglieder) oder nur zu beschränkten Zeiten zur Verfügung steht | | hier wird vermerkt, wenn ein Angebot nur für eine bestimmte Zielgruppe (z.B. SeniorInnen, Vereinsmitglieder) oder nur zu beschränkten Zeiten zur Verfügung steht | ||
|- | |- | ||
| FahrplanLink | | FahrplanLink | ||
− | |||
| URL des Fahrplans | | URL des Fahrplans | ||
|- | |- | ||
| Fahrzeug/Transportkapazität ''(deprecated)'' | | Fahrzeug/Transportkapazität ''(deprecated)'' | ||
− | |||
| Art des eingesetzten Fahrzeugs | | Art des eingesetzten Fahrzeugs | ||
|- | |- | ||
| FlexRaum | | FlexRaum | ||
− | |||
| räumliche Flexibilität, mögliche Werte: | | räumliche Flexibilität, mögliche Werte: | ||
*Haltestelle-Haltestelle | *Haltestelle-Haltestelle | ||
Zeile 157: | Zeile 142: | ||
|- | |- | ||
| FlexZeit | | FlexZeit | ||
− | |||
| zeitliche Flexibilität: | | zeitliche Flexibilität: | ||
*mit Fahrplan | *mit Fahrplan | ||
Zeile 164: | Zeile 148: | ||
|- | |- | ||
| HaltestellenplanLink | | HaltestellenplanLink | ||
− | |||
| URL des Haltestellenplans | | URL des Haltestellenplans | ||
|- | |- | ||
| Hat Einschränkung | | Hat Einschränkung | ||
− | |||
| ist dieses Angebot mit Einschränkungen (Zielgruppe, Betriebszeiten etc.) verbunden? (wahr/falsch) | | ist dieses Angebot mit Einschränkungen (Zielgruppe, Betriebszeiten etc.) verbunden? (wahr/falsch) | ||
|- | |- | ||
| Homepage | | Homepage | ||
− | |||
| Webseite des Angebots | | Webseite des Angebots | ||
|- | |- | ||
Zeile 180: | Zeile 161: | ||
|- | |- | ||
| Modell | | Modell | ||
− | |||
| Organisationsmodell (analog zu den Beschreibungen im Handbuch On-Demand) | | Organisationsmodell (analog zu den Beschreibungen im Handbuch On-Demand) | ||
|- | |- | ||
− | | | + | | Öffnungszeitenszeiten in maschinenlesbarem Format |
− | |||
− | |||
|- | |- | ||
| Online-Buchung | | Online-Buchung | ||
− | |||
| URL für Online-Buchung | | URL für Online-Buchung | ||
|- | |- | ||
| Personal | | Personal | ||
− | |||
| mögliche Werte: | | mögliche Werte: | ||
*bezahlt | *bezahlt | ||
Zeile 198: | Zeile 174: | ||
|- | |- | ||
| Software | | Software | ||
− | |||
| eingesetzte Software, z.B. Cover, Via, Trapeze, DABS, ISTmobil | | eingesetzte Software, z.B. Cover, Via, Trapeze, DABS, ISTmobil | ||
|- | |- | ||
| Vorbestellzeit | | Vorbestellzeit | ||
− | |||
| wie viele Minuten im Voraus muss das Angebot bestellt werden? | | wie viele Minuten im Voraus muss das Angebot bestellt werden? | ||
|- | |- | ||
| Vorbestellzeit-Text | | Vorbestellzeit-Text | ||
− | |||
| Vorbestellzeit wie im Formular eingegeben (kann auch in Stunden oder Tagen eingegeben werden) | | Vorbestellzeit wie im Formular eingegeben (kann auch in Stunden oder Tagen eingegeben werden) | ||
|- | |- | ||
| Zielgruppe | | Zielgruppe | ||
− | |||
| mögliche Werte | | mögliche Werte | ||
*uneingeschränkt | *uneingeschränkt | ||
Zeile 226: | Zeile 198: | ||
|- | |- | ||
| Verbundintegration | | Verbundintegration | ||
− | |||
| ist das Angebot in irgendeiner Form in den Verbund integriert (wahr/falsch) | | ist das Angebot in irgendeiner Form in den Verbund integriert (wahr/falsch) | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} |
Version vom 25. Oktober 2023, 13:12 Uhr
Zugriffspunkt[ ]
Die API ist über https://bedarfsverkehr.at/w/api.php
oder https://mobil-am-land.at/w/api.php
zugänglich
Parameter[ ]
Die API benötigt/akzeptiert folgende Parameter:
Parameter | Wert | Beschreibung |
---|---|---|
action |
askargs |
Semantic MediaWiki-Query |
format |
json |
Rückgabeformat (zur Fehlersuche steht auch "jsonfm", eine HTML-Repräsentation von JSON zur Verfügung) |
parameters |
limit=1000 |
Anzahl der zurückgegebenen Datensätze ist standardmäßig begrenzt, deshalb hohes Limit setzen |
conditions |
Bedienungsgebiet-GeoJSON::+ |
Abfragebedingungen, mehrere Bedingungen mit Pipe trennen |
printouts |
Bedienungsgebiet-GeoJSON |
Rückgabewerte, mehrere Felder mit Pipe trennen |
Die Beispielabfrage wählt alle Datensätze aus, für die ein Wert im Feld „Bedienungsgebiet-GeoJSON“ angegeben wurde und gibt den Wert für dieses Feld zurück: http://bedarfsverkehr.at/w/api.php?action=askargs&conditions=Bedienungsgebiet-GeoJSON%3A%3A%2B&printouts=Bedienungsgebiet-GeoJSON¶meters=limit%3D1000&format=jsonfm
Struktur des relevanten Teils der Antwort:
{ "query": { "results": [ { "printouts": [ { "label": "Bedienungsgebiet-GeoJSON", "0":"{\"type\":\"MultiPolygon\",\"coordinates\":[...]}" } ], "fulltext": "Gmoabus Breitenbrunn" } ] } }
query.results[0].fulltext
enthält also den Namen des Angebots
Anmerkung zum Feld „Bedienungsgebiet-GeoJSON“: GeoJSON kann derzeit nur als Textfeld gespeichert werden, der zurückgegebene Wert muss also erst geparsed werden!
Auswahlkriterien für öffentlich zugängliche, hochflexible Bedarfsverkehre[ ]
Leider sind viele der in unserer Datenbank erfassten Bedarfsverkehre von Einschränkungen betroffen, weil sie nur für eine bestimmte Zielgruppe (z.B. Vereinsmitglieder, Senior*innen oder Gemeindebürger*innen) oder nur zu ausgewählten Betriebszeiten zur Verfügung stehen.
Manche Bedarfsverkehre verkehren nicht im Flächenbetrieb (von Haustür zu Haustür), sondern zwischen Haltepunkten und teilweise mit fixen Fahrplänen. Da Haltepunkte und Fahrpläne in unserer Datenbank derzeit nicht erfasst sind, können diese aktuell nur eingeschränkt beauskunftet werden.
Zur Auswahl von hochflexiblen, Taxi-artigen Bedarfsverkehren, die uneingeschränkt öffentlich zugänglich sind, können die folgenden „Conditions“ verwendet werden:
- Kategorie:Bedarfsverkehr
- aktiv::wahr
- FlexZeit::nach Bedarf
- FlexRaum::Tür-Tür
- Bundesland::+
- Bedienungsgebiet-GeoJSON::+
folgende „Printouts“ stehen (u.a.) zur Verfügung:
- Bestellnummer
- Homepage
- Öffnungszeiten
- Vorbestellzeit
- Bedienungsgebiet-GeoJSON
- Einschränkung
- LetzterCheck
Hinweis: Leider kennt die API keine Negativ-Conditions, deshalb müssen Angebote mit Einschränkungen (bei denen also das Feld „Einschränkung“ einen Inhalt hat) im Nachhinein herausgefiltert werden!
allgemeine Schnittstellen-Dokumentation von Semantic MediaWiki[ ]
Die API wird über die MediaWiki-Erweiterung Semantic MediaWiki bereitgestellt. Weitere Informationen finden sich daher auch in der Dokumentation des SMW-API Moduls „askargs“.
Liste aller Datenbankfelder[ ]
Datenbankfelder zum Betrieb[ ]
Feld | Kurzbeschreibung | |
---|---|---|
aktiv | ist der Bedarfsverkehr aktuell in Betrieb oder erst geplant bzw. eingestellt? (wahr/falsch) | |
App-Android | URL zum Download der Android-App zur Buchung des Angebots | |
App-iOS | URL zum Download der iOS-App zur Buchung des Angebots | |
Bestellnummer | Telefonnummer, unter der der Bedarfsverkehr bestellt werden kann | |
Betreiberkonstellation | mögliche Werte:
| |
ähnlich funktionierende Systeme werden als „Betriebsformen“ in Gruppen zusammengefasst (z.B. Anruf-Sammeltaxi, Rufbus, Gemeindebusse, Citytaxi etc.) | ||
grobe Einteilung der Qualität der Betriebszeiten, mögliche Werte:
| ||
Einschränkung | hier wird vermerkt, wenn ein Angebot nur für eine bestimmte Zielgruppe (z.B. SeniorInnen, Vereinsmitglieder) oder nur zu beschränkten Zeiten zur Verfügung steht | |
FahrplanLink | URL des Fahrplans | |
Fahrzeug/Transportkapazität (deprecated) | Art des eingesetzten Fahrzeugs | |
FlexRaum | räumliche Flexibilität, mögliche Werte:
| |
FlexZeit | zeitliche Flexibilität:
| |
HaltestellenplanLink | URL des Haltestellenplans | |
Hat Einschränkung | ist dieses Angebot mit Einschränkungen (Zielgruppe, Betriebszeiten etc.) verbunden? (wahr/falsch) | |
Homepage | Webseite des Angebots | |
Modell | Organisationsmodell (analog zu den Beschreibungen im Handbuch On-Demand) | |
Öffnungszeitenszeiten in maschinenlesbarem Format | ||
Online-Buchung | URL für Online-Buchung | |
Personal | mögliche Werte:
| |
Software | eingesetzte Software, z.B. Cover, Via, Trapeze, DABS, ISTmobil | |
Vorbestellzeit | wie viele Minuten im Voraus muss das Angebot bestellt werden? | |
Vorbestellzeit-Text | Vorbestellzeit wie im Formular eingegeben (kann auch in Stunden oder Tagen eingegeben werden) | |
Zielgruppe | mögliche Werte
| |
Verbundintegration | ist das Angebot in irgendeiner Form in den Verbund integriert (wahr/falsch) |