POST api/Account/Login

Validates an e-mail address and password combination, returns detailed results

Request Information

URI Parameters

None.

Body Parameters

LoginValues
NameDescriptionTypeAdditional information
EmailAddress

string

None.

Password

string

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<LoginValues xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AdStore.Api.ViewModels">
  <EmailAddress>sample string 1</EmailAddress>
  <Password>sample string 2</Password>
</LoginValues>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="EmailAddress"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Password"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

LoginResult
NameDescriptionTypeAdditional information
UserID

globally unique identifier

None.

Success

boolean

None.

LockedOut

boolean

None.

InActive

boolean

None.

PasswordInvalid

boolean

None.

NoneExisting

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "UserID": "4e20188d-ba7f-4159-882c-95db7764aed3",
  "Success": true,
  "LockedOut": true,
  "InActive": true,
  "PasswordInvalid": true,
  "NoneExisting": true
}

application/xml, text/xml

Sample:
<LoginResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AdStore.Api.ViewModels">
  <InActive>true</InActive>
  <LockedOut>true</LockedOut>
  <NoneExisting>true</NoneExisting>
  <PasswordInvalid>true</PasswordInvalid>
  <Success>true</Success>
  <UserID>4e20188d-ba7f-4159-882c-95db7764aed3</UserID>
</LoginResult>

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="UserID"

4e20188d-ba7f-4159-882c-95db7764aed3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Success"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="LockedOut"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="InActive"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PasswordInvalid"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="NoneExisting"

True
--MultipartDataMediaFormatterBoundary1q2w3e--