maas-schemas

request Schema

http://maasglobal.com/maas-backend/booking-option-create/request.json

Request schema for booking-option-create

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	Yes	Develop	No	Forbidden	Forbidden	maas-backend/booking-option-create/request.json

Schema Hierarchy

• request http://maasglobal.com/maas-backend/booking-option-create/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
agencyOptions	agencyOptions	http://maasglobal.com/maas-backend/booking-option-create/request.json#/definitions/option
autoPurchaseId	uuid	http://maasglobal.com/maas-backend/booking-option-create/request.json#/definitions/option
customerSelection	customerSelection	http://maasglobal.com/maas-backend/booking-option-create/request.json#/definitions/option
paymentSourceId	paymentSourceId	http://maasglobal.com/maas-backend/booking-option-create/request.json#/definitions/option
productId	id	http://maasglobal.com/maas-backend/booking-option-create/request.json#/definitions/option
rollbackOnFailure	boolean	http://maasglobal.com/maas-backend/booking-option-create/request.json#/definitions/option

agencyOptions

agencyOptions

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

agencyOptions Type

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

autoPurchaseId

autoPurchaseId

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

autoPurchaseId Type

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

customerSelection

customerSelection

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

customerSelection Type

• customerSelection – http://maasglobal.com/core/components/customerSelection.json

paymentSourceId

paymentSourceId

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

paymentSourceId Type

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

productId

productId

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

productId Type

• id – http://maasglobal.com/core/product.json#/definitions/id

rollbackOnFailure

If one of these is true, then all bookings will be cancelled

rollbackOnFailure

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

rollbackOnFailure Type

boolean

request Properties

Property	Type	Required	Nullable	Defined by
headers	object	Required	No	request (this schema)
identityId	complex	Required	No	request (this schema)
payload	option	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

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"

payload

payload

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

payload Type

Array type: option

All items must be of the type:

• option – #/definitions/option

This site is open source. Improve this page.