POST api/Account/Login

Used for FACEOFFERS login.

Request Information

URI Parameters

None.

Body Parameters

UserLoginViewModel
NameDescriptionTypeAdditional information
Username

The user name of the User.

string

None.

Password

The password for the User.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Username": "sample string 1",
  "Password": "sample string 2"
}

application/xml, text/xml

Sample:
<UserLoginViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FaceOffers.Api.Models">
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
</UserLoginViewModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UserLoginViewModel'.

Response Information

Resource Description

UserInfoViewModel
NameDescriptionTypeAdditional information
Succeeded

Indicates whether the login is successful.

boolean

None.

Id

Id of the User

string

None.

FirstName

First name for the User

string

None.

LastName

Last name for the User

string

None.

ZipCode

Zipcode for the User

string

None.

ProfileImage

Image of the User

string

None.

Email

Email address for the User

string

None.

PhoneNumber

Phone number for the User

string

None.

MerchantId

MerchantId for the Merchant

globally unique identifier

None.

SalesFlashConsumerId

SalesFlashConsumerId for the SalesFlashConsumer

globally unique identifier

None.

MobileNumber

Mobile number for the User

string

None.

EmailConfirmed

Indicates whether the User email has been confirmed

boolean

None.

PhoneNumberConfirmed

Indicates whether the User phone number has been confirmed

boolean

None.

RegistrationCompleted

Indicates whether User registration has completed

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Succeeded": true,
  "Id": "sample string 2",
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "ZipCode": "sample string 5",
  "ProfileImage": "sample string 6",
  "Email": "sample string 7",
  "PhoneNumber": "sample string 8",
  "MerchantId": "706de4c5-b9d7-4b10-a86c-3d9f689e521a",
  "SalesFlashConsumerId": "9a89d3dc-97d0-42da-a9bc-3ea323ab0091",
  "MobileNumber": "sample string 11",
  "EmailConfirmed": true,
  "PhoneNumberConfirmed": true,
  "RegistrationCompleted": true
}

application/xml, text/xml

Sample:
<UserInfoViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FaceOffers.Api.Models">
  <Email>sample string 7</Email>
  <EmailConfirmed>true</EmailConfirmed>
  <FirstName>sample string 3</FirstName>
  <Id>sample string 2</Id>
  <LastName>sample string 4</LastName>
  <MerchantId>706de4c5-b9d7-4b10-a86c-3d9f689e521a</MerchantId>
  <MobileNumber>sample string 11</MobileNumber>
  <PhoneNumber>sample string 8</PhoneNumber>
  <PhoneNumberConfirmed>true</PhoneNumberConfirmed>
  <ProfileImage>sample string 6</ProfileImage>
  <RegistrationCompleted>true</RegistrationCompleted>
  <SalesFlashConsumerId>9a89d3dc-97d0-42da-a9bc-3ea323ab0091</SalesFlashConsumerId>
  <Succeeded>true</Succeeded>
  <ZipCode>sample string 5</ZipCode>
</UserInfoViewModel>