kumi/oebb_py
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Apparently, GitLab doesn't handle line breaks in URLs properly.

Browse source
This commit is contained in:
Klaus-Uwe Mitterer 2017-09-28 20:57:05 +02:00
parent 5613f49e08
commit 7fe58e503f
1 changed files with 17 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -53,8 +53,8 @@ This makes a request to [OpenStreetMap](https://osm.org/) to find the stations
closest to given coordinates. Issues may occur where station names in OSM differ closest to given coordinates. Issues may occur where station names in OSM differ
from those used internally by ÖBB. from those used internally by ÖBB.
* [Example "nearby" request](https://bahnapi.xyz/?type=nearby&lat=47.489& * [Example "nearby" request]
lon=9.69) (https://bahnapi.xyz/?type=nearby&lat=47.489&lon=9.69)
### Search for connections between two stops ("conn") ### Search for connections between two stops ("conn")
@ -79,8 +79,8 @@ It is not required that the station names provided in "from" and "to" exactly
match the stations' official names. A "val" request will always be made match the stations' official names. A "val" request will always be made
implicitly and the closest match will be used. implicitly and the closest match will be used.
* [Example "conn" request from "Leibitz" to "Kaldorf"](https://bahnapi.xyz/? * [Example "conn" request from "Leibitz" to "Kaldorf"]
type=conn&from=Leibitz&to=Kaldorf) (https://bahnapi.xyz/?type=conn&from=Leibitz&to=Kaldorf)
By default, the response will not include some information, including at which By default, the response will not include some information, including at which
stations a change to a different service is required, if applicable. It will, stations a change to a different service is required, if applicable. It will,
@ -90,25 +90,26 @@ Note that this request is going to take considerably longer to process. If at
all possible, do not set "count" higher than 1 when requesting details as too all possible, do not set "count" higher than 1 when requesting details as too
many connections may cause the query to time-out. many connections may cause the query to time-out.
* [Example "conn" request without details](https://bahnapi.xyz/?type=conn&from= * [Example "conn" request without details]
Strobl&to=Wien) (https://bahnapi.xyz/?type=conn&from=Strobl&to=Wien)
* [Same request with details](https://bahnapi.xyz/?type=conn&from=Strobl&to=Wien * [Same request with details]
&details) (https://bahnapi.xyz/?type=conn&from=Strobl&to=Wien&details)
If "count" is not set, one connection will be returned. This value may safely be If "count" is not set, one connection will be returned. This value may safely be
increased up to 6 if "details" is not set. increased up to 6 if "details" is not set.
* [Example "conn" request for five connections](https://bahnapi.xyz/?type=conn& * [Example "conn" request for five connections]
from=Thörl&to=Pama&count=5) (https://bahnapi.xyz/?type=conn&from=Thörl&to=Pama&count=5)
The provided "time" will by default be considered as the requested time of The provided "time" will by default be considered as the requested time of
departure. To use it as the time of arrival instead, the "mode" parameter may departure. To use it as the time of arrival instead, the "mode" parameter may
be set to "arr". be set to "arr".
* [Example "conn" request using time of departure](https://bahnapi.xyz/? * [Example "conn" request using time of departure]
type=conn&from=Wolkersdorf&to=Götzendorf&time=12:00) (https://bahnapi.xyz/?type=conn&from=Wolkersdorf&to=Götzendorf&time=12:00)
* [Same request using time of arrival](https://bahnapi.xyz/?type=conn&from= * [Same request using time of arrival]
Wolkersdorf&to=Götzendorf&time=12:00&mode=arr) (https://bahnapi.xyz/?type=conn&from=Wolkersdorf&to=Götzendorf
&time=12:00&mode=arr)
### Short requests ### Short requests
@ -126,5 +127,5 @@ parameters as usual.
By default, the API returns its results as XML. If you prefer JSON, you may add By default, the API returns its results as XML. If you prefer JSON, you may add
the "json" parameter to your query. the "json" parameter to your query.
* [Example "nearby" request returning JSON](https://bahnapi.xyz/?type=nearby& * [Example "nearby" request returning JSON]
lat=48.293&lon=16.482) (https://bahnapi.xyz/?type=nearby&lat=48.293&lon=16.482)