maas-schemas

request Schema

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

Request schema for stations list

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

Schema Hierarchy

• request http://maasglobal.com/maas-backend/stations/stations-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	complex	Required	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 required
• type: complex
• defined in this schema

payload Type

One of the following conditions need to be fulfilled.

Condition 1

object with following properties:

Property	Type	Required
agencyId		Required
lat		Required
lon		Required
radius	integer	Optional
type		Required

agencyId

agencyId

• is required
• type: agencyId

agencyId Type

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

lat

lat

• is required
• type: relaxedLatitude

lat Type

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

lon

lon

• is required
• type: relaxedLatitude

lon Type

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

radius

radius

• is optional
• type: integer

radius Type

integer

• minimum value: 0

type

type

• is required
• type: enum

The value of this property must be equal to one of the known values below.

type Known Values

Value	Description
origin
destination
viaAvoid

Condition 2

object with following properties:

Property	Type	Required
agencyId		Required
count	integer	Required
name	string	Required
type		Required

agencyId

agencyId

• is required
• type: agencyId

agencyId Type

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

count

count

• is required
• type: integer

count Type

integer

• minimum value: 1

name

name

• is required
• type: string

name Type

string

• minimum length: 3 characters

type

type

• is required
• type: enum

The value of this property must be equal to one of the known values below.

type Known Values

Value	Description
origin
destination
viaAvoid

This site is open source. Improve this page.