API von bedarfsverkehr.at/mobil-am-land.at: Unterschied zwischen den Versionen
Zeile 81: | Zeile 81: | ||
=== Liste aller Datenbankfelder === | === Liste aller Datenbankfelder === | ||
− | + | ||
+ | {| class="table table-bordered table-sm sortable" style="font-size:small" | ||
|- | |- | ||
! Feld | ! Feld |
Version vom 31. Mai 2021, 12:38 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[ ]
Feld | Gruppe | Beschreibung |
---|---|---|
aktiv | Betrieb | ist der Bedarfsverkehr aktuell in Betrieb oder erst geplant bzw. eingestellt? (wahr/falsch) |
App-Android | Betrieb | URL zum Download der Android-App zur Buchung des Angebots |
App-iOS | Betrieb | URL zum Download der iOS-App zur Buchung des Angebots |
Beschreibung | Betrieb | beschreibender Text zum Bedarfsverkehr (aktuell wird das Feld mit der Beschreibung der „Betriebsform“ befüllt) |
Bestellnummer | Betrieb | Telefonnummer, unter der der Bedarfsverkehr bestellt werden kann |
Betreiberkonstellation | Betrieb | mögliche Werte:
|
Betriebsform | Betrieb | ähnlich funktionierende Systeme werden als „Betriebsformen“ in Gruppen zusammengefasst (z.B. Anruf-Sammeltaxi, Rufbus, Gemeindebusse, Citytaxi etc.) |
Betriebszeit | Betrieb | grobe Einteilung der Qualität der Betriebszeiten, mögliche Werte:
|
Einschränkung | Betrieb | 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 | Betrieb | URL des Fahrplans |
Fahrzeug/Transportkapazität | Betrieb | Art des eingesetzten Fahrzeugs |
FlexRaum | Betrieb | räumliche Flexibilität, mögliche Werte:
|
FlexZeit | Betrieb | zeitliche Flexibilität:
|
HaltestellenplanLink | Betrieb | URL des Haltestellenplans |
Homepage | Betrieb | Webseite des Angebots |
Merkmal | Betrieb | besondere Merkmale, z.B. Einsatz eines Elektrofahrzeugs oder ÖPNV-Tarifintegration |
Öffnungszeiten | Betrieb | Betriebszeiten in maschinenlesbarem Format |
Online-Buchung | Betrieb | URL für Online-Buchung |
Personal | Betrieb | mögliche Werte:
|
Software | Betrieb | eingesetzte Software, z.B. Cover, Via, Trapeze, DABS, ISTmobil |
Vorbestellzeit | Betrieb | wie viele Minuten im Voraus muss das Angebot bestellt werden? |
Zielgruppe | Betrieb | mögliche Werte
|
Ansprechpartner | Kontakt | Kontaktinformationen |
LetzterCheck | Metainformation | wann wurde das Angebot zuletzt überprüft? |
Quelle | Metainformation | woher stammen die in der Datenbank vorhandenen Informationen? (Liste) |
VAO ID | Metainformation | unter welcher ID wurde der Bedarfsverkehr in die VAO aufgenommen |
Bedienungsgebiet | Ort | mögliche Werte (wird automatisch auf Region gesetzt, wenn das Bedienungsgebiet mehr als eine Gemeinde umfasst):
|
Bedienungsgebiet-GeoJSON | Ort | Polygon des Bedienungsgebiets (für Bedarfsverkehre mit Flächenbetrieb) |
Bedienungsgebiet-RelationID | Ort | RelationID der Gemeindegrenzen auf OpenStreetMap |
Bundesland | Ort | Bundesland |
GKZ | Ort | Gemeindekennzahl der betroffenen Gemeinden (Liste) |
Lage | Ort | Koordinaten eines Punkts im Bediengebiet |
Ort | Ort | betroffene Gemeinden (Liste) |
BF | Statistik | Anzahl der Beförderungsfälle pro Jahr |
BFjeEWJahr | Statistik | Anzahl der Beförderungsfälle pro EinwohnerIn und Jahr |
Betriebsbeginn | Statistik | Datum des Betriebsbeginns |
Betriebsende | Statistik | Datum des Betriebsende (falls Angebot eingestellt) |
Betriebskosten | Statistik | jährliche Betriebskosten |
BetriebskostenjeBF | Statistik | durchschnittliche Betriebskosten je Beförderungsfall |
EinwohnerKat | Statistik | mögliche Werte:
|
EinwohnerTausend | Statistik | EinwohnerInnen im Bedienungsgebiet (in Tausend) |
Einwohnerzahl | Statistik | EinwohnerInnen im Bedienungsgebiet |
Fahrgeldeinnahmen | Statistik | jährliche Fahrgeldeinnahmen |
Gefahrene Kilometer | Statistik | jährlich zurückgelegte Kilometer |
Gemeindefläche | Statistik | Fläche der Gemeinde |
Gemeindezahl | Statistik | Anzahl der betroffenen Gemeinden |
Gästebeten | Statistik | Anzahl der Gästebetten in den betroffenen Gemeinden |
Jahr | Statistik | Jahr des Betriebsbeginns |
Stand | Statistik | mögliche Werte:
|
Einzelticket | Tarif | Preis eines Einzeltickets |
EinzelticketPreissegment | Tarif | Preissegment des Einzeltickets (ganzzahlige Rundung) |
ExklusiverVorverkauf | Tarif | sind Tickets nur im Vorverkauf erhältlich (wahr/falsch) |
Jahreskarte | Tarif | Preis einer Jahreskarte |
Monatskarte | Tarif | Preis einer Monatskarte |
Tageskarte | Tarif | Preis einer Tageskarte |
Tarifmodell | Tarif | mögliche Werte:
|
Tarifanmerkungen | Tarif | Textfeld zur Beschreibung tariflicher Besonderheiten |
Wochenkarte | Tarif | Preis einer Wochenkarte |