http://maasglobal.com/maas-backend/provider/routes/request.json
Request schema for routes providers
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Defined In |
|---|---|---|---|---|---|---|
| Can be instantiated | No | Develop | No | Forbidden | Forbidden | maas-backend/provider/routes/request.json |
http://maasglobal.com/maas-backend/provider/routes/request.json
http://maasglobal.com/core/components/units.jsonhttp://maasglobal.com/core/components/units-geo.jsonhttp://maasglobal.com/core/components/address.jsonhttp://maasglobal.com/core/components/station.jsonhttp://maasglobal.com/core/components/travel-mode.json| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| arriveBy | integer |
Optional | No | request (this schema) |
| from | array |
Required | No | request (this schema) |
| fromAddress | string |
Optional | No | request (this schema) |
| fromName | string |
Optional | No | request (this schema) |
| fromStationId | string |
Optional | No | request (this schema) |
| identityId | complex | Optional | No | request (this schema) |
| leaveAt | integer |
Optional | No | request (this schema) |
| modes | travel-mode | Optional | No | request (this schema) |
| to | array |
Required | No | request (this schema) |
| toAddress | string |
Optional | No | request (this schema) |
| toName | string |
Optional | No | request (this schema) |
| toStationId | string |
Optional | No | request (this schema) |
^(optionalParameters).+ |
multiple | Pattern | No | request (this schema) |
POSIX time in milliseconds, https://en.wikipedia.org/wiki/Unix_time
arriveBy
integerinteger
14516064009007199254740991Geographic latitude-longitude number-pair array in WGS-84 system, see https://en.wikipedia.org/wiki/World_Geodetic_System
from
arrayArray type: array
All items must be of the type: Unknown type ``.
{
"description": "Geographic latitude-longitude number-pair array in WGS-84 system, see https://en.wikipedia.org/wiki/World_Geodetic_System",
"type": "array",
"items": [
{
"$ref": "#/definitions/latitude",
"$linkVal": "latitude",
"$linkPath": "units-geo.md"
},
{
"$ref": "#/definitions/longitude",
"$linkVal": "longitude",
"$linkPath": "units-geo.md"
}
],
"additionalItems": false,
"$linkVal": "shortLocation",
"$linkPath": "units-geo.md",
"isrequired": true,
"simpletype": "`array`"
}
Encoded address components. Check the regexr examples. Check https://regexr.com/4ofcq. In streetNumber, there are 2 dashes - they have 2 different unicodes, do not remove
fromAddress
stringstring
"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
stringstring
fromStationId
stringstring
identityId
Any following options needs to be fulfilled.
string
All instances must conform to this regular expression
^[aepus]{2}-[\w]{4}-\d:[a-f\d]{8}(-[a-f\d]{4}){3}-[a-f\d]{12}$
string
All instances must conform to this regular expression
^[A-Fa-f0-9]{8}(-[A-Fa-f0-9]{4}){3}-[A-Fa-f0-9]{12}$
"eu-west-1:4828507e-683f-41bf-9d87-689808fbf958"
"4828507e-683f-41bf-9d87-689808fbf958"
POSIX time in milliseconds, https://en.wikipedia.org/wiki/Unix_time
leaveAt
integerinteger
14516064009007199254740991modes
http://maasglobal.com/core/components/travel-mode.jsonGeographic latitude-longitude number-pair array in WGS-84 system, see https://en.wikipedia.org/wiki/World_Geodetic_System
to
arrayArray type: array
All items must be of the type: Unknown type ``.
{
"description": "Geographic latitude-longitude number-pair array in WGS-84 system, see https://en.wikipedia.org/wiki/World_Geodetic_System",
"type": "array",
"items": [
{
"$ref": "#/definitions/latitude",
"$linkVal": "latitude",
"$linkPath": "units-geo.md"
},
{
"$ref": "#/definitions/longitude",
"$linkVal": "longitude",
"$linkPath": "units-geo.md"
}
],
"additionalItems": false,
"$linkVal": "shortLocation",
"$linkPath": "units-geo.md",
"isrequired": true,
"simpletype": "`array`"
}
Encoded address components. Check the regexr examples. Check https://regexr.com/4ofcq. In streetNumber, there are 2 dashes - they have 2 different unicodes, do not remove
toAddress
stringstring
"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
stringstring
toStationId
stringstring
^(optionalParameters).+Applies to all properties that match the regular expression ^(optionalParameters).+
^(optionalParameters).+
Unknown type string,number,boolean.
{
"type": ["string", "number", "boolean"],
"simpletype": "multiple"
}