maas-schemas

request Schema

http://maasglobal.com/maas-backend/itineraries/itinerary-create/request.json

Request schema for itineraries-create

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

Schema Hierarchy

• request http://maasglobal.com/maas-backend/itineraries/itinerary-create/request.json
  • units http://maasglobal.com/core/components/units.json
  • api-common http://maasglobal.com/core/components/api-common.json
  • message http://maasglobal.com/core/components/message.json

request Definitions

Property	Type	Group
customerSelections	object[]	http://maasglobal.com/maas-backend/itineraries/itinerary-create/request.json#/definitions/outwardReturnWrapper
itinerary	itinerary	http://maasglobal.com/maas-backend/itineraries/itinerary-create/request.json#/definitions/outwardReturnWrapper

customerSelections

customerSelections

• is optional
• type: object[]
• defined in this schema

customerSelections Type

Array type: object[]

All items must be of the type: object with following properties:

Property	Type	Required
customerSelection		Optional
ref		Optional

customerSelection

customerSelection

• is optional
• type: customerSelection

customerSelection Type

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

ref

ref

• is optional
• type: ref

ref Type

• ref – http://maasglobal.com/core/product-option.json#/definitions/ref

itinerary

itinerary

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

itinerary Type

• itinerary – http://maasglobal.com/core/itinerary.json

request Properties

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

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

message

message

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

message Type

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

payload

payload

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

payload Type

object with following properties:

Property	Type	Required
itinerary	itinerary	Optional
outward		Optional
paymentSourceId	string	Optional
return		Optional

itinerary

itinerary

• is optional
• type: itinerary

itinerary Type

• itinerary – http://maasglobal.com/core/itinerary.json

outward

outward

• is optional
• type: outwardReturnWrapper

outward Type

• outwardReturnWrapper – #/definitions/outwardReturnWrapper

paymentSourceId

paymentSourceId

• is optional
• type: paymentSourceId

paymentSourceId Type

string

• minimum length: 3 characters
• maximum length: 255 characters

return

return

• is optional
• type: outwardReturnWrapper

return Type

• outwardReturnWrapper – #/definitions/outwardReturnWrapper

This site is open source. Improve this page.