maas-schemas

request Schema

http://maasglobal.com/maas-backend/profile/profile-favoriteLocations-delete/request.json

Request schema for profile-favoriteLocations-delete

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

Schema Hierarchy

• request http://maasglobal.com/maas-backend/profile/profile-favoriteLocations-delete/request.json
  • units http://maasglobal.com/core/components/units.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)

headers

headers

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

headers Type

object with following properties:

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

Accept

SemVer versioning schemas for versioning our resources

Accept

• is optional
• type: acceptHeader

Accept Type

string

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

\bapplication/json[;,]\s*version=((0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(-[\da-z\-]+(?:\.[\da-z\-]+)*)?(?:\+[\da-z\-]+(?:\.[\da-z\-]+)*)?)\b

X-Whim-User-Agent

X-Whim-User-Agent

• is optional
• type: userAgentHeader

X-Whim-User-Agent Type

string

• minimum length: 1 characters

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
name	string	Required

name

name

• is required
• type: string

name Type

string

• minimum length: 1 characters
• maximum length: 255 characters

This site is open source. Improve this page.