maas-schemas

request Schema

http://maasglobal.com/maas-backend/bookings/bookings-agency-options/request.json

Request schema for bookings-agency-options

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	Yes	Develop	No	Forbidden	Forbidden	maas-backend/bookings/bookings-agency-options/request.json

Schema Hierarchy

request http://maasglobal.com/maas-backend/bookings/bookings-agency-options/request.json
- units http://maasglobal.com/core/components/units.json
- api-common http://maasglobal.com/core/components/api-common.json

request Definitions

Property	Type	Group
agencyId	agencyId	`http://maasglobal.com/maas-backend/bookings/bookings-agency-options/request.json#/definitions/payload`
bookingIdToExtend	uuid	`http://maasglobal.com/maas-backend/bookings/bookings-agency-options/request.json#/definitions/payload`
endTime	time	`http://maasglobal.com/maas-backend/bookings/bookings-agency-options/request.json#/definitions/payload`
from	shortLocationString	`http://maasglobal.com/maas-backend/bookings/bookings-agency-options/request.json#/definitions/payload`
fromAddress	componentAddress	`http://maasglobal.com/maas-backend/bookings/bookings-agency-options/request.json#/definitions/payload`
fromName	placeName	`http://maasglobal.com/maas-backend/bookings/bookings-agency-options/request.json#/definitions/payload`
fromRadius	distance	`http://maasglobal.com/maas-backend/bookings/bookings-agency-options/request.json#/definitions/payload`
mode	travel-mode	`http://maasglobal.com/maas-backend/bookings/bookings-agency-options/request.json#/definitions/payload`
startTime	time	`http://maasglobal.com/maas-backend/bookings/bookings-agency-options/request.json#/definitions/payload`
to	shortLocationString	`http://maasglobal.com/maas-backend/bookings/bookings-agency-options/request.json#/definitions/payload`
toAddress	componentAddress	`http://maasglobal.com/maas-backend/bookings/bookings-agency-options/request.json#/definitions/payload`
toName	placeName	`http://maasglobal.com/maas-backend/bookings/bookings-agency-options/request.json#/definitions/payload`
toRadius	distance	`http://maasglobal.com/maas-backend/bookings/bookings-agency-options/request.json#/definitions/payload`

agencyId

agencyId

is optional
type: agencyId
defined in this schema

agencyId Type

agencyId – http://maasglobal.com/core/components/common.json#/definitions/agencyId

bookingIdToExtend

bookingId to fetch possible extension options for

bookingIdToExtend

is optional
type: uuid
defined in this schema

bookingIdToExtend Type

uuid – http://maasglobal.com/core/components/units.json#/definitions/uuid

endTime

endTime

is optional
type: time
defined in this schema

endTime Type

time – http://maasglobal.com/core/components/units.json#/definitions/time

from

from

is optional
type: shortLocationString
defined in this schema

from Type

shortLocationString – http://maasglobal.com/core/components/units-geo.json#/definitions/shortLocationString

fromAddress

Componentized from address

fromAddress

is optional
type: componentAddress
defined in this schema

fromAddress Type

componentAddress – http://maasglobal.com/core/components/address.json#/definitions/componentAddress

fromName

The human understandable name for ‘from’

fromName

is optional
type: placeName
defined in this schema

fromName Type

placeName – http://maasglobal.com/core/components/address.json#/definitions/placeName

fromRadius

fromRadius

is optional
type: distance
defined in this schema

fromRadius Type

distance – http://maasglobal.com/core/components/units-geo.json#/definitions/distance

mode

mode

is optional
type: travel-mode
defined in this schema

mode Type

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

startTime

startTime

is optional
type: time
defined in this schema

startTime Type

time – http://maasglobal.com/core/components/units.json#/definitions/time

to

to

is optional
type: shortLocationString
defined in this schema

to Type

shortLocationString – http://maasglobal.com/core/components/units-geo.json#/definitions/shortLocationString

toAddress

Componentized to address

toAddress

is optional
type: componentAddress
defined in this schema

toAddress Type

componentAddress – http://maasglobal.com/core/components/address.json#/definitions/componentAddress

toName

The human understandable name for ‘to’

toName

is optional
type: placeName
defined in this schema

toName Type

placeName – http://maasglobal.com/core/components/address.json#/definitions/placeName

toRadius

toRadius

is optional
type: distance
defined in this schema

toRadius Type

distance – http://maasglobal.com/core/components/units-geo.json#/definitions/distance

request Properties

Property	Type	Required	Nullable	Defined by
headers	`object`	Required	No	request (this schema)
identityId	complex	Required	No	request (this schema)
payload	`object`	Required	No	request (this schema)

headers

headers

is required
type: object
defined in this schema

headers Type

object with following properties:

Property	Type	Required
`Accept`		Optional
`X-Whim-User-Agent`		Optional

Accept

Accept

is optional
type: acceptHeader

Accept Type

acceptHeader – #/definitions/acceptHeader

X-Whim-User-Agent

X-Whim-User-Agent

is optional
type: userAgentHeader

X-Whim-User-Agent Type

userAgentHeader – #/definitions/userAgentHeader

identityId

identityId

is required
type: complex
defined in this schema

identityId Type

Any following options needs to be fulfilled.

Option 1

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}$

test example: eu-west-1:4828507e-683f-41bf-9d87-689808fbf958

Option 2