Cookies helfen uns bei der Bereitstellung von mobil-am-land.at. Durch die Nutzung von mobil-am-land.at erklären Sie sich damit einverstanden, dass wir Cookies speichern. Weitere Informationen

API von bedarfsverkehr.at/mobil-am-land.at: Unterschied zwischen den Versionen

Aus mobil-am-land.at
Wechseln zu: Navigation, Suche
(Die Seite wurde neu angelegt: „=== Zugriffspunkt === Die API ist über <code>https://bedarfsverkehr.at/w/api.php</code> oder <code>https://bedarfsverkehr.at/w/api.php</code> zugänglich =…“)
 
Zeile 10: Zeile 10:
 
! Parameter !! Wert !! Beschreibung
 
! Parameter !! Wert !! Beschreibung
 
|-
 
|-
| action || "askargs" || Semantic MediaWiki-Query
+
| action || <code>askargs</code> || Semantic MediaWiki-Query
 
|-
 
|-
| format || "json" || Rückgabeformat (zur Fehlersuche steht auch "jsonfm", eine HTML-Repräsentation von JSON zur Verfügung)
+
| format || <code>json</code> || 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
+
| parameters || <code>limit=1000</code> || Anzahl der zurückgegebenen Datensätze ist standardmäßig begrenzt, deshalb hohes Limit setzen
 
|-
 
|-
| conditions || ''"Bedienungsgebiet-GeoJSON::+"'' || Abfragebedingungen, mehrere Bedingungen mit Pipe trennen
+
| conditions || ''<code>Bedienungsgebiet-GeoJSON::+</code>'' || Abfragebedingungen, mehrere Bedingungen mit Pipe trennen
 
|-
 
|-
| printouts || ''"Bedienungsgebiet-GeoJSON"'' || Rückgabewerte, mehrere Felder mit Pipe trennen
+
| printouts || ''<code>Bedienungsgebiet-GeoJSON</code>'' || Rückgabewerte, mehrere Felder mit Pipe trennen
 
|}
 
|}
  

Version vom 31. Mai 2021, 12:21 Uhr

Zugriffspunkt[ ]

Die API ist über https://bedarfsverkehr.at/w/api.php oder https://bedarfsverkehr.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&parameters=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, sollten 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

vollständiger resultierender API-Call: http://bedarfsverkehr.at/w/api.php?action=askargs&conditions=Kategorie%3ABedarfsverkehr%7Caktiv%3A%3Awahr%7CFlexZeit%3A%3Anach%20Bedarf%7CFlexRaum%3A%3AT%C3%BCr-T%C3%BCr%7CBundesland%3A%3A%2B%7CBedienungsgebiet-GeoJSON%3A%3A%2B&printouts=Bestellnummer%7CHomepage%7C%C3%96ffnungszeiten%7CVorbestellzeit%7CBedienungsgebiet-GeoJSON%7CEinschr%C3%A4nkung%7CLetzterCheck&parameters=limit%3D1000&format=json

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“.