User

Description

The User entity is used to represent the details for a user in the OneGreatFamily system.

Entity Elements

Name Description Required

FirstName

The users first name

Type: String

Constraints: Must be less than 20 characters

Yes

LastName

The users last name

Type: String

Constraints: Must be less than 30 characters

Yes

EmailAddress

The users email address

Type: String

Constraints: Must be less than 100 characters and of the format user@host.domain

Yes

Password

The password associated with the user

Type: String

Constraints: Must be less than 20 characters

Yes

ProductId

Product Id associated with this user (must get a valid product ID from a OneGreatFamily representative)

Type: String

Constraints: Must be a valid product ID from a OneGreatFamily representative.
Please contact: devws@onegreatfamily.com for more information.

Yes

PhoneNumber

The users phone number

Type: String

Constraints: Must be less than 25 characters not including dashes or spaces.

No

UserName

The username associated with the user (note: this is usually the email address)

Type: String

Constraints: Deprecated, Only used on an user read  or user update call of an existing account. Not used on CreateAccount

No

Ogfn

The user ogfn

Type: UInt64

Constraints: Must be a valid user ogfn

No

Address

Address associated with the  User

Type: Address

Constraints: None

No
CreditCard

Credit card information associated with the user

Type: CreditCard

Constraints: Only used on User Create call and User Update call. CreditCard information is not returned on an User Read call.

No
GroupOgfns

A collection of group ogfns the user is a member of.

Type: Collection of UInt64

Constraints: None

No
IndiOgfn

Ogfn of the individual for this user

Type: UInt64

Constraints: None

No