maas-schemas

request Schema

http://maasglobal.com/maas-backend/customers/favorite-locations/update/request.json

MaaS customer favorite locations updating

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Develop	No	Forbidden	Forbidden	maas-backend/customers/favorite-locations/update/request.json

Schema Hierarchy

• request http://maasglobal.com/maas-backend/customers/favorite-locations/update/request.json
  • units http://maasglobal.com/core/components/units.json
  • partialFavoriteLocation http://maasglobal.com/core/partialFavoriteLocation.json
  • api-common http://maasglobal.com/core/components/api-common.json

request Properties

Property	Type	Required	Nullable	Defined by
customerId	complex	Required	No	request (this schema)
favoriteLocationId	number	Required	No	request (this schema)
headers	object	Required	No	request (this schema)
identityId	complex	Required	No	request (this schema)
payload	partialFavoriteLocation	Required	No	request (this schema)

customerId

customerId

• is required
• type: complex
• defined in this schema

customerId 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

customerId Examples

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

"4828507e-683f-41bf-9d87-689808fbf958"

favoriteLocationId

favoriteLocationId

• is required
• type: number
• defined in this schema

favoriteLocationId Type

number

headers

headers

• is required
• 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: partialFavoriteLocation
• defined in this schema

payload Type

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

This site is open source. Improve this page.