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

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

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

customerId Examples

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

favoriteLocationId

favoriteLocationId

favoriteLocationId Type

number

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