maas-schemas

request Schema

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

Request schema for bookings-retrieve

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

Schema Hierarchy

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

request Properties

Property	Type	Required	Nullable	Default	Defined by
bookingId	string	Required	No		request (this schema)
headers	object	Optional	No		request (this schema)
identityId	complex	Required	No		request (this schema)
refresh	boolean	Optional	No	false	request (this schema)

bookingId

bookingId of the requested booking

bookingId

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

bookingId Type

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

• test example: 4828507e-683f-41bf-9d87-689808fbf958

bookingId Example

"4828507e-683f-41bf-9d87-689808fbf958"

headers

headers

• is optional
• 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

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

• test example: 4828507e-683f-41bf-9d87-689808fbf958

identityId Examples

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

"4828507e-683f-41bf-9d87-689808fbf958"

refresh

Whether or not to refresh the booking from the TSP end

refresh

• is optional
• type: boolean
• default: false
• defined in this schema

refresh Type

boolean

This site is open source. Improve this page.