API von bedarfsverkehr.at/mobil-am-land.at: Unterschied zwischen den Versionen
Zeile 279: | Zeile 279: | ||
! Feld | ! Feld | ||
! Kurzbeschreibung | ! Kurzbeschreibung | ||
+ | |- | ||
+ | | Beförderungsfälle | ||
+ | | Anzahl der Beförderungsfälle pro Jahr | ||
+ | |- | ||
+ | | Beförderungsfälle je EinwohnerIn und Jahr | ||
+ | | Anzahl der Beförderungsfälle pro EinwohnerIn und Jahr | ||
+ | |- | ||
+ | | Betriebsbeginn | ||
+ | | Datum des Betriebsbeginns | ||
+ | |- | ||
+ | | Betriebsende | ||
+ | | Datum des Betriebsende (falls Angebot eingestellt) | ||
+ | |- | ||
+ | | Betriebskosten | ||
+ | | jährliche Betriebskosten | ||
+ | |- | ||
+ | | BetriebskostenjeBF | ||
+ | | durchschnittliche Betriebskosten je Beförderungsfall | ||
+ | |- | ||
+ | | EinwohnerInnen im Bediengebiet | ||
+ | | EinwohnerInnen im Bedienungsgebiet | ||
+ | |- | ||
+ | | EinwohnerKat | ||
+ | | mögliche Werte: | ||
+ | *A unter 1.000 | ||
+ | *B 1.000-2.000 | ||
+ | *C 2.000-5.000 | ||
+ | *D 5.000-10.000 | ||
+ | *E über 10.000 | ||
+ | |- | ||
+ | | EinwohnerTausend | ||
+ | | EinwohnerInnen im Bedienungsgebiet (in Tausend) | ||
+ | |- | ||
+ | | Einwohnerzahl | ||
+ | | EinwohnerInnen im Bedienungsgebiet | ||
+ | |- | ||
+ | | Fahrgeldeinnahmen | ||
+ | | jährliche Fahrgeldeinnahmen | ||
+ | |- | ||
+ | | Fahrzeugkilometer je Beförderungsfall | ||
+ | | je Beförderungsfall zurückgelegte Fahrzeugkilometer | ||
+ | |- | ||
+ | | Fläche Bediengebiet | ||
+ | | Fläche des Bediengebiets in km² | ||
+ | |- | ||
+ | | Kilometerleistung | ||
+ | | jährlich zurückgelegte Kilometer | ||
+ | |- | ||
+ | | Kostendeckung | ||
+ | | Anteil der Fahrgeldeinnahmen an den Gesamtkosten | ||
+ | |- | ||
+ | | Kosten je Beförderungsfall | ||
+ | | | ||
+ | |- | ||
+ | | Kosten je Fahrzeugkilometer | ||
+ | | Kosten je gefahrenem Kilometer | ||
+ | |- | ||
+ | | Gemeindefläche | ||
+ | | Fläche der Gemeinde | ||
+ | |- | ||
+ | | Gemeindezahl | ||
+ | | Anzahl der betroffenen Gemeinden | ||
+ | |- | ||
+ | | Gästebetten | ||
+ | | Anzahl der Gästebetten in den betroffenen Gemeinden | ||
+ | |- | ||
+ | | Jahr | ||
+ | | Jahr des Betriebsbeginns | ||
+ | |- | ||
+ | | Modal Split | ||
+ | | Anteil des Angebots am Modal Split im Bediengebiet (berechnet auf Grundlage der EinwohnerInnen im Bediengebiet und der durchschnittlichen Wegezahl der österreichischen Gesamtbevölkerung) | ||
|} | |} | ||
Version vom 25. Oktober 2023, 13:35 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[ ]
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(n), unter der der Bedarfsverkehr bestellt werden kann (mehrere Werte möglich) |
Betreiberkonstellation | mögliche Werte:
|
Betriebsstunden | Zahl der wöchentlichen Betriebsstunden |
Betriebszeit | grobe Einteilung der Qualität der Betriebszeiten, mögliche Werte:
Angebote, die nur in den Nachtstunden verkehren oder nur saisonal zur Verfügung stehen haben den Wert „nur zu bestimmten Zeiten“. |
Betriebszeiten | Betriebsszeiten in einem für Menschen lesbaren Format |
Einschränkung | hier wird vermerkt, wenn ein Angebot nur mit Einschränkungen zur Verfügung steht. Mögliche Werte (mehrere Werte möglich):
|
FahrplanLink | URL des Fahrplans |
FlexRaum | räumliche Flexibilität, mögliche Werte:
|
FlexZeit | zeitliche Flexibilität, mögliche Werte:
|
HaltestellenplanLink | URL des Haltestellenplans |
Hat Einschränkung | ist dieses Angebot mit Einschränkungen (Zielgruppe, Betriebszeiten etc.) verbunden (siehe Attribut Einschränkung)? (wahr/falsch) |
Homepage | Webseite des Angebots |
Modell | Organisationsmodell (analog zu den Beschreibungen im Handbuch On-Demand) |
Öffnungszeiten | Betriebszeiten 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) |
Metainformation[ ]
Feld | Kurzbeschreibung |
---|---|
LetzterCheck | wann wurde das Angebot zuletzt überprüft? |
Quelle | woher stammen die in der Datenbank vorhandenen Informationen? (Liste) |
VAO ID | unter welcher ID wurde der Bedarfsverkehr in die VAO aufgenommen (oder „eingebunden“, falls ID nicht verfügbar) |
Ort[ ]
Feld | Kurzbeschreibung |
---|---|
Bedienungsgebiet | mögliche Werte:
Wird automatisch auf Region gesetzt, wenn das Bedienungsgebiet mehr als eine Gemeinde umfasst. |
Bedienungsgebiet-GeoJSON | Polygon des Bedienungsgebiets (für Bedarfsverkehre mit Flächenbetrieb) |
Bedienungsgebiet-RelationID | RelationID der Gemeindegrenzen auf OpenStreetMap |
Bundesland | Bundesland |
GKZ | Gemeindekennzahl der betroffenen Gemeinden (Liste) |
Haltestellenkategorie | höchste Haltestellenkategorie (der ÖV-Güteklassen) im Bediengebiet |
Land | Land, in dem sich der Bedarfsverkehr befindet |
Ort | betroffene Gemeinden (Liste) |
Raumtyp | Raumtypen der betroffenen Gemeinden (Liste)
Diese Einteilung erfolgt analog zur Kategorisierung bei Österreich unterwegs 2013/14. |
Urban-Rural-Typ | Ziffer der Urban-Rural-Kategorisierung der betroffenen Gemeinden (Liste) |
Urban-Rural-Typ-Kategorie | Ziffer der Urban-Rural-Hauptkategorisierung der betroffenen Gemeinden (Liste) [1-4] |
Urban-Rural-Typ-Text | (sortierbare) textliche Beschreibung der Urban-Rural-Kategorisierung der betroffenen Gemeinden (Liste), z.B. „I Ländlicher Raum, zentral“ |
Urban-Rural-Typ-Kategorie-Text | (sortierbare) textliche Beschreibung der Urban-Rural-Hauptkategorisierung der betroffenen Gemeinden (Liste), z.B. „d Ländlicher Raum“ |
Statistik[ ]
Feld | Kurzbeschreibung |
---|---|
Beförderungsfälle | Anzahl der Beförderungsfälle pro Jahr |
Beförderungsfälle je EinwohnerIn und Jahr | Anzahl der Beförderungsfälle pro EinwohnerIn und Jahr |
Betriebsbeginn | Datum des Betriebsbeginns |
Betriebsende | Datum des Betriebsende (falls Angebot eingestellt) |
Betriebskosten | jährliche Betriebskosten |
BetriebskostenjeBF | durchschnittliche Betriebskosten je Beförderungsfall |
EinwohnerInnen im Bediengebiet | EinwohnerInnen im Bedienungsgebiet |
EinwohnerKat | mögliche Werte:
|
EinwohnerTausend | EinwohnerInnen im Bedienungsgebiet (in Tausend) |
Einwohnerzahl | EinwohnerInnen im Bedienungsgebiet |
Fahrgeldeinnahmen | jährliche Fahrgeldeinnahmen |
Fahrzeugkilometer je Beförderungsfall | je Beförderungsfall zurückgelegte Fahrzeugkilometer |
Fläche Bediengebiet | Fläche des Bediengebiets in km² |
Kilometerleistung | jährlich zurückgelegte Kilometer |
Kostendeckung | Anteil der Fahrgeldeinnahmen an den Gesamtkosten |
Kosten je Beförderungsfall | |
Kosten je Fahrzeugkilometer | Kosten je gefahrenem Kilometer |
Gemeindefläche | Fläche der Gemeinde |
Gemeindezahl | Anzahl der betroffenen Gemeinden |
Gästebetten | Anzahl der Gästebetten in den betroffenen Gemeinden |
Jahr | Jahr des Betriebsbeginns |
Modal Split | Anteil des Angebots am Modal Split im Bediengebiet (berechnet auf Grundlage der EinwohnerInnen im Bediengebiet und der durchschnittlichen Wegezahl der österreichischen Gesamtbevölkerung) |
Tarif[ ]
Feld | Kurzbeschreibung |
---|
nicht mehr verfügbare Datenbankfelder (oder deprecated)[ ]
Feld | Kurzbeschreibung |
---|---|
Betriebsform (deprecated) | ähnlich funktionierende Systeme werden als „Betriebsformen“ in Gruppen zusammengefasst (z.B. Anruf-Sammeltaxi, Rufbus, Gemeindebusse, Citytaxi etc.) |
Fahrzeug/Transportkapazität (deprecated) | Art des eingesetzten Fahrzeugs |
Lage (deprecated) | Koordinaten eines Punkts im Bediengebiet |