maas-schemas

request Schema

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

MaaS geocoding query request schema.

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

Schema Hierarchy

request Properties

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

headers

headers

headers Type

object with following properties:

Property Type Required
Accept   Optional
X-Whim-User-Agent   Optional

Accept

Accept

Accept Type

X-Whim-User-Agent

X-Whim-User-Agent

X-Whim-User-Agent Type

identityId

identityId

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}$

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}$

identityId Examples

"eu-west-1:4828507e-683f-41bf-9d87-689808fbf958"
"4828507e-683f-41bf-9d87-689808fbf958"

payload

payload

payload Type

object with following properties:

Property Type Required Default
count integer Optional 5
distance number Optional  
lat number Required  
locale string Optional "fi-FI"
lon number Required  
name string Required  

count

count

count Type

integer

distance

Distance in meters

distance

distance Type

number

lat

No-numeric precision version of MaaS core latitude

lat

lat Type

number

locale

locale

locale Type

string

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

^[a-z]{2,3}(?:-[a-zA-Z]{4})?(?:-[A-Z]{2,3})?$

lon

No-numeric precision version of MaaS core longitude

lon

lon Type

number

name

name

name Type

string