maas-schemas

request Schema

http://maasglobal.com/maas-backend/profile/profile-devices-put/request.json

Request schema for profile-active-plan-put

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated No Develop No Forbidden Forbidden maas-backend/profile/profile-devices-put/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 Optional 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
deviceIdentifier string Required
devicePushToken string Required
deviceType string Required

deviceIdentifier

Universally unique identifier, see https://en.wikipedia.org/wiki/Universally_unique_identifier

deviceIdentifier

deviceIdentifier Type

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}$
deviceIdentifier Example
4828507e-683f-41bf-9d87-689808fbf958

devicePushToken

Push token - 32 chars in iOS, up to 255 in Android

devicePushToken

devicePushToken Type

string

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

^.{32,255}$

deviceType

deviceType

The value of this property must be equal to one of the known values below.

deviceType Known Values
Value Description
iOS  
Android