Back

GET api/v1/Account/Status/{userName}

Get user account status details.Provides information if the user is registered or not and can use the RMail email service.
Note: Request url should add a trailing '/' at the end. For example: api/Account/Status/user@example.com/

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userName

Username i.e. the email address user is registered with.

string

Required

Body Parameters

None.

Sample Request

Response Information

Resource Description

UserAccountStatusViewModel
NameDescriptionTypeAdditional information
FirstName

User's first name

string

None.

LastName

User's last name

string

None.

RegisteredUser

True if the user is registered , false otherwise

boolean

None.

EmailConfirmed

True if user's email has been confirmed , false otherwise

boolean

None.

UserStatusInRMailService

Details if the user is registered to use RMail service

UserStatusInRMailService

None.

Sample Response

application/json, text/json

Sample:
{
  "FirstName": "John",
  "LastName": "Smith",
  "RegisteredUser": true,
  "EmailConfirmed": true,
  "UserStatusInRMailService": {
    "RegisteredUser": true,
    "Status": "Active"
  }
}