Update Readme
This commit is contained in:
parent
52c32dcc83
commit
03338d2e48
11
README.md
11
README.md
|
@ -117,12 +117,19 @@ Götzendorf/Leitha&time=12:00&mode=arr)
|
||||||
For "val" and "conn" requests, it is possible to use shorter requests by passing
|
For "val" and "conn" requests, it is possible to use shorter requests by passing
|
||||||
arguments in the path. Paths consisting of one part (i.e. /value) will be
|
arguments in the path. Paths consisting of one part (i.e. /value) will be
|
||||||
handled as "val" requests while those consisting of two parts (/value1/value2)
|
handled as "val" requests while those consisting of two parts (/value1/value2)
|
||||||
will be handled as "conn" requests. Optional values can be passed as GET or POST
|
will be handled as "conn" requests, where the first value would be the station
|
||||||
parameters as usual.
|
of departure and the second value would be the station of arrival. Optional
|
||||||
|
values can be passed as GET or POST parameters as usual.
|
||||||
|
|
||||||
* [Example short "val" request](https://bahnapi.xyz/Kanfanar)
|
* [Example short "val" request](https://bahnapi.xyz/Kanfanar)
|
||||||
* [Example short "conn" request](https://bahnapi.xyz/Bregenz/Neusiedl am See)
|
* [Example short "conn" request](https://bahnapi.xyz/Bregenz/Neusiedl am See)
|
||||||
|
|
||||||
|
This syntax is intended primarily for manual requests as additional sanity
|
||||||
|
checks for input data would be required to use it programatically.
|
||||||
|
Specifically, station names would not be allowed to include "/" and may not be
|
||||||
|
empty or contain only whitespace, as this will make it impossible to detect the
|
||||||
|
correct request type.
|
||||||
|
|
||||||
### Output format
|
### Output format
|
||||||
|
|
||||||
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
|
||||||
|
|
Loading…
Reference in a new issue