http://maasglobal.com/tsp/journey-planner/request.json
Request schema for getting journey options from a TSP adapter.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Defined In |
|---|---|---|---|---|---|---|
| Can be instantiated | No | Develop | No | Forbidden | Permitted | tsp/journey-planner/request.json |
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| payload | object |
Optional | No | request (this schema) |
^(optionalParameters).+ |
multiple | Pattern | No | request (this schema) |
* |
any | Additional | Yes | this schema allows additional properties |
payload
objectobject with following properties:
| Property | Type | Required |
|---|---|---|
arriveBy |
integer | Optional |
arriveByReturn |
integer | Optional |
from |
string | Optional |
fromAddress |
string | Optional |
fromName |
string | Optional |
fromStationId |
string | Optional |
leaveAt |
integer | Optional |
leaveAtReturn |
integer | Optional |
mode |
string | Optional |
to |
string | Optional |
toAddress |
string | Optional |
toName |
string | Optional |
toStationId |
string | Optional |
POSIX time in milliseconds, https://en.wikipedia.org/wiki/Unix_time
arriveBy
integer
14516064009007199254740991POSIX time in milliseconds, https://en.wikipedia.org/wiki/Unix_time
arriveByReturn
integer
14516064009007199254740991Geographic latitude-longitude number-pair as a string in WGS-84 system, see https://en.wikipedia.org/wiki/World_Geodetic_System
from
string
^[+-]?\d{1,3}(\.\d+)?,[+-]?\d{1,3}(\.\d+)?$
Componentized from address
fromAddress
string
state:Tōkyō-to|district:Kanda Nishikichō 3-chōme|streetNumber:4-パレステュディオ御茶ノ水駿河台参番館|zipCode:101-0054|city:Chiyoda-City|country:Japan
streetName:Tarkk'ampujänkätu|city:Helsinki|country:Finland|state:Uusimaa|streetNumber:1|zipCode:00100|district:Tapiola
streetName:Hämeentie Töölöntori Lähettilääntie Tarkk'ampujänkätu
streetName:Brädgårdsgatan
streetName:Żółkiewskiego
streetName:Øster Allé
streetName:شارع حمدان بن محمد
streetName:Karl-Marx-Straße
streetName:Küçük Ayasofya|city:İstanbul|district:Fatih
streetName:11 Avenue d’Ostende
streetName:Küçük Ayasofya, Küçük Ayasofya Cami Sk.
streetName:Kasumi'gaseki
streetName:St Martin's Lane
country:Åland
country:Puerto Rico
country:français
country:skandinavisk
streetNumber:1-1
streetNumber:1/2-d2
Place name (given in autocomplete)
fromName
string
fromStationId
string
POSIX time in milliseconds, https://en.wikipedia.org/wiki/Unix_time
leaveAt
integer
14516064009007199254740991POSIX time in milliseconds, https://en.wikipedia.org/wiki/Unix_time
leaveAtReturn
integer
14516064009007199254740991mode
stringstring
Geographic latitude-longitude number-pair as a string in WGS-84 system, see https://en.wikipedia.org/wiki/World_Geodetic_System
to
string
^[+-]?\d{1,3}(\.\d+)?,[+-]?\d{1,3}(\.\d+)?$
Componentized to address
toAddress
string
state:Tōkyō-to|district:Kanda Nishikichō 3-chōme|streetNumber:4-パレステュディオ御茶ノ水駿河台参番館|zipCode:101-0054|city:Chiyoda-City|country:Japan
streetName:Tarkk'ampujänkätu|city:Helsinki|country:Finland|state:Uusimaa|streetNumber:1|zipCode:00100|district:Tapiola
streetName:Hämeentie Töölöntori Lähettilääntie Tarkk'ampujänkätu
streetName:Brädgårdsgatan
streetName:Żółkiewskiego
streetName:Øster Allé
streetName:شارع حمدان بن محمد
streetName:Karl-Marx-Straße
streetName:Küçük Ayasofya|city:İstanbul|district:Fatih
streetName:11 Avenue d’Ostende
streetName:Küçük Ayasofya, Küçük Ayasofya Cami Sk.
streetName:Kasumi'gaseki
streetName:St Martin's Lane
country:Åland
country:Puerto Rico
country:français
country:skandinavisk
streetNumber:1-1
streetNumber:1/2-d2
Place name (given in autocomplete)
toName
string
toStationId
string
^(optionalParameters).+Applies to all properties that match the regular expression ^(optionalParameters).+
^(optionalParameters).+
Unknown type string,number,boolean.
{
"type": ["string", "number", "boolean"],
"simpletype": "multiple"
}