maas-schemas

agencyOptions Schema

http://maasglobal.com/core/components/agencyOptions.json

Options that can be used for available booking options

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Develop	No	Forbidden	Forbidden	core/components/agencyOptions.json

Schema Hierarchy

• agencyOptions http://maasglobal.com/core/components/agencyOptions.json
  • travel-mode http://maasglobal.com/core/components/travel-mode.json
  • common http://maasglobal.com/core/components/common.json
  • units http://maasglobal.com/core/components/units.json
  • units-geo http://maasglobal.com/core/components/units-geo.json
  • address http://maasglobal.com/core/components/address.json

agencyOptions Properties

Property	Type	Required	Nullable	Defined by
agencyId	string	Optional	No	agencyOptions (this schema)
endTime	integer	Optional	No	agencyOptions (this schema)
from	string	Optional	No	agencyOptions (this schema)
fromAddress	string	Optional	No	agencyOptions (this schema)
fromName	string	Optional	No	agencyOptions (this schema)
fromRadius	number	Optional	No	agencyOptions (this schema)
mode	travel-mode	Optional	No	agencyOptions (this schema)
startTime	integer	Optional	No	agencyOptions (this schema)
to	string	Optional	No	agencyOptions (this schema)
toAddress	string	Optional	No	agencyOptions (this schema)
toName	string	Optional	No	agencyOptions (this schema)
toRadius	number	Optional	No	agencyOptions (this schema)

agencyId

agencyId

• is optional
• type: string
• defined in this schema

agencyId Type

string

• minimum length: 2 characters
• maximum length: 64 characters

endTime

POSIX time in milliseconds, https://en.wikipedia.org/wiki/Unix_time

endTime

• is optional
• type: integer
• defined in this schema

endTime Type

integer

• minimum value: 1451606400
• maximum value: 9007199254740991

from

Geographic latitude-longitude number-pair as a string in WGS-84 system, see https://en.wikipedia.org/wiki/World_Geodetic_System

from

• is optional
• type: string
• defined in this schema

from Type

string

• minimum length: 1 characters
• maximum length: 64 characters All instances must conform to this regular expression (test examples here):

^[+-]?\d{1,3}(\.\d+)?,[+-]?\d{1,3}(\.\d+)?$

fromAddress

Componentized from address

fromAddress

• is optional
• type: string
• defined in this schema

fromAddress Type

string

fromAddress Examples

"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"

fromName

The human understandable name for ‘from’

fromName

• is optional
• type: string
• defined in this schema

fromName Type

string

• minimum length: 1 characters

fromRadius

Distance in meters

fromRadius

• is optional
• type: number
• defined in this schema

fromRadius Type

number

• minimum value: 0
• maximum value: 40075000
• must be a multiple of 1

mode

mode

• is optional
• type: travel-mode
• defined in this schema

mode Type

• travel-mode – http://maasglobal.com/core/components/travel-mode.json

startTime

POSIX time in milliseconds, https://en.wikipedia.org/wiki/Unix_time

startTime

• is optional
• type: integer
• defined in this schema

startTime Type

integer

• minimum value: 1451606400
• maximum value: 9007199254740991

to

Geographic latitude-longitude number-pair as a string in WGS-84 system, see https://en.wikipedia.org/wiki/World_Geodetic_System

to

• is optional
• type: string
• defined in this schema

to Type

string

• minimum length: 1 characters
• maximum length: 64 characters All instances must conform to this regular expression (test examples here):

^[+-]?\d{1,3}(\.\d+)?,[+-]?\d{1,3}(\.\d+)?$

toAddress

Componentized to address

toAddress

• is optional
• type: string
• defined in this schema

toAddress Type

string

toAddress Examples

"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"

toName

The human understandable name for ‘to’

toName

• is optional
• type: string
• defined in this schema

toName Type

string

• minimum length: 1 characters

toRadius

Distance in meters

toRadius

• is optional
• type: number
• defined in this schema

toRadius Type

number

• minimum value: 0
• maximum value: 40075000
• must be a multiple of 1

This site is open source. Improve this page.