maas-schemas

request Schema

http://maasglobal.com/maas-backend/autocomplete/autocomplete-query/request.json

Request schema for autocomplete

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

Schema Hierarchy

• request http://maasglobal.com/maas-backend/autocomplete/autocomplete-query/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	Optional	No	request (this schema)
payload	object	Optional	No	request (this schema)
*	any	Additional	Yes	this schema allows additional properties

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"

payload

payload

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

payload Type

object with following properties:

Property	Type	Required	Default
count	integer	Optional	5
lat	number	Optional
lon	number	Optional
name	string	Required
radius	number	Optional	5000

count

count

• is optional
• type: integer
• default: 5

count Type

integer

• minimum value: 1
• maximum value: 100

lat

No-numeric precision version of MaaS core latitude

lat

• is optional
• type: relaxedLatitude

lat Type

number

• minimum value: -90
• maximum value: 90

lon

No-numeric precision version of MaaS core longitude

lon

• is optional
• type: relaxedLongitude

lon Type

number

• minimum value: -180
• maximum value: 180

name

Place name (given in autocomplete)

name

• is required
• type: placeName

name Type

string

• minimum length: 1 characters

radius

Distance in meters

radius

• is optional
• type: distance
• default: 5000

radius Type

number

• minimum value: 0
• maximum value: 40075000
• must be a multiple of 1

This site is open source. Improve this page.