maas-schemas

request Schema

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

Request schema for bookings-list

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

Schema Hierarchy

• request http://maasglobal.com/maas-backend/bookings/bookings-list/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	Defined by
headers	object	Optional	No	request (this schema)
identityId	complex	Required	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 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 optional
• type: object
• defined in this schema

payload Type

object with following properties:

Property	Type	Required
endTime	integer	Optional
modes	string	Optional
startTime	integer	Optional
states	string	Optional

endTime

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

endTime

• is optional
• type: time

endTime Type

integer

• minimum value: 1451606400
• maximum value: 9007199254740991

modes

modes

• is optional
• type: string

modes Type

string

All instances must conform to this regular expression (test examples here):

^([A-Ö,_]+,)*[A-Ö,_]+$

startTime

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

startTime

• is optional
• type: time

startTime Type

integer

• minimum value: 1451606400
• maximum value: 9007199254740991

states

states

• is optional
• type: string

states Type

string

All instances must conform to this regular expression (test examples here):

^([A-Ö]+,)*[A-Ö]+$

This site is open source. Improve this page.