maas-schemas

personalData Schema

http://maasglobal.com/maas-backend/customers/personalData.json

MaaS customer personal data schema

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

Schema Hierarchy

• personalData http://maasglobal.com/maas-backend/customers/personalData.json
  • common http://maasglobal.com/core/components/common.json
  • address http://maasglobal.com/core/components/address.json

personalData Properties

Property	Type	Required	Nullable	Defined by
address	string	Optional	No	personalData (this schema)
city	string	Optional	No	personalData (this schema)
country	string	Optional	No	personalData (this schema)
dob	complex	Optional	No	personalData (this schema)
email	string	Optional	No	personalData (this schema)
firstName	string	Optional	No	personalData (this schema)
firstNameLocalized	string	Optional	No	personalData (this schema)
honorifics	string	Optional	No	personalData (this schema)
lastName	string	Optional	No	personalData (this schema)
lastNameLocalized	string	Optional	No	personalData (this schema)
phone	string	Optional	No	personalData (this schema)
profileImageUrl	string	Optional	No	personalData (this schema)
sex	string	Optional	No	personalData (this schema)
ssid	complex	Optional	No	personalData (this schema)
state	string	Optional	No	personalData (this schema)
subscriberType	string	Optional	No	personalData (this schema)
zipCode	string	Optional	No	personalData (this schema)

address

Street address (and optional number), http://www.bitboost.com/ref/international-address-formats.html

address

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

address Type

string

• minimum length: 2 characters

city

Alphabetic city name

city

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

city Type

string

• minimum length: 1 characters

country

ISO 3166-1 alpha-2 country code, see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

country

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

country Type

string

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

^[A-Z]{2,2}$

dob

The customer’s date of birth or boolean indicating if the value is already in DB

dob

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

dob Type

Any following options needs to be fulfilled.

Option 1

boolean

Option 2

• isoDate – http://maasglobal.com/core/components/units.json#/definitions/isoDate

email

Rough validation of a valid e-mail address

email

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

email Type

string

• maximum length: 64 characters All instances must conform to this regular expression

^.+@.+\..+$

• test example: joe.customer@example.com

email Example

"joe.customer@example.com"

firstName

First name of the customer (e.g. John)

firstName

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

firstName Type

string

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

firstNameLocalized

Localized first name of the customer (e.g. John)

firstNameLocalized

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

firstNameLocalized Type

string

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

honorifics

honorifics

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

honorifics Type

string

lastName

Last name of the customer (e.g. Doe)

lastName

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

lastName Type

string

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

lastNameLocalized

Localized last name of the customer (e.g. Doe)

lastNameLocalized

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

lastNameLocalized Type

string

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

phone

ITU-T E.164 phone number

phone

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

phone Type

string

All instances must conform to this regular expression

^\+(?:\d){6,14}\d$

• test example: +358401234567

phone Example

"+358401234567"

profileImageUrl

profileImageUrl

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

profileImageUrl Type

string

• minimum length: 10 characters
• maximum length: 1024 characters

sex

sex

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

sex Type

string

ssid

Social Security ID

ssid

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

ssid Type

Any following options needs to be fulfilled.

Option 1

boolean

Option 2

• ssid – http://maasglobal.com/core/components/common.json#/definitions/ssid

state

Alphabetic state name

state

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

state Type

string

• maximum length: 64 characters

subscriberType

Subscriber Type

subscriberType

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

subscriberType Type

string

zipCode

Numeric zip code, see https://en.wikipedia.org/wiki/Postal_code

zipCode

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

zipCode Type

string

• minimum length: 2 characters
• maximum length: 64 characters

This site is open source. Improve this page.