User

User

This resource represents the currently authenticated user.

 

Get current user

Returns info for the current user.

Request

Query parameters

User details of specified user.  The UserID is obtained from UserAccount or Account.

GET /api/User

{ "EmailAddress": "some.user@email.com", "VerifyCode": null, "Password": null, "Name": "Some User", "Addr1": "302 S Stewart Ave", "Addr2": null, "City": "Addison", "State": "IL", "ZipCode": "60101", "MobilePhone": "630-930-5115", "Birthday": null, "NewUser": null, "NotifyCycleComplete": true, "Language": "en", "UserID": 9, "Fingerprint": null, "AllowEmailEdit": false, "EmailVerifyRequest": null, "Privileges": 1 }

Get specific user

Returns info about a specific user on a specific account.

Requirements:  Account Admin or 'User Manager' privilege

Request

Path parameters

The UserID of the user. This can be obtained from /UserAccount or /Account.

Query parameters

The FasCard account ID.

Response

Field Name

Type

Description

Notes

Field Name

Type

Description

Notes

EmailAddress

string

Email address

 

VerifyCode

string

Verification code

 

Password

string

User password

 

Name

string

User name

 

Addr1

string

Address #1

 

Addr2

string

Address #2

 

City

string

City

 

State

string

State

 

ZipCode

string

Zip code

 

MobilePhone

string

Mobile phone

 

Birthday

DateTime

Birthday

May be NULL if n/a

NewUser

bool

True if new user

 

NotifyCycleComplete

bool

True to send email when cycle is nearly complete

 

Language

string

User's preferred language

"en" = English

"es" = Spanish

UserID

int

User Rec ID

 

AllowEmailEdit

bool

True if user is not yet validated and thus capable of modifying email

 

EmailVerifyRequest

bool

Set True to request verification email

Only used for unverified email (AllowEmailEdit=True)

Privileges

int

User privileges

0 = standard, >0 = support

GET /api/User/{userID}?AccountID={accountID}

{ "EmailAddress": "some.user@email.com", "VerifyCode": null, "Password": null, "Name": "Some User", "Addr1": "302 S Stewart Ave", "Addr2": null, "City": "Addison", "State": "IL", "ZipCode": "60101", "MobilePhone": "630-930-5115", "Birthday": null, "NewUser": null, "NotifyCycleComplete": true, "Language": "en", "UserID": 9, "Fingerprint": null, "AllowEmailEdit": false, "EmailVerifyRequest": null, "Privileges": 1 }

Edit user details

Edit details of specified user.  The UserID is obtained from UserAccount or Account.

Requirements:  Account Admin or 'User Manager' privilege

post /api/User/{userID}?AccountID={accountID}


Remove current user details

Remove all personal details and login credentials for current user

DELETE /api/User