POST Api/v{apiVersion}/Account/Login

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

Request Information

URI Parameters

Name	Description	Type	Additional information
apiVersion		string	None.

Body Parameters

LoginValues

Name	Description	Type	Additional 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/Hier.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

Name	Type	Additional information
UserID	globally unique identifier	None.
ApiKey	globally unique identifier	None.
Success	boolean	None.
LockedOut	boolean	None.
InActive	boolean	None.
NotExistsOrInvalidPassword	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "UserID": "f5339a7d-76d8-4563-8882-613544adc333",
  "ApiKey": "1ce3c867-3f36-4338-b8d9-7af14268f547",
  "Success": true,
  "LockedOut": true,
  "InActive": true,
  "NotExistsOrInvalidPassword": true
}

application/xml, text/xml

Sample:

<LoginResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hier.Api.ViewModels">
  <ApiKey>1ce3c867-3f36-4338-b8d9-7af14268f547</ApiKey>
  <InActive>true</InActive>
  <LockedOut>true</LockedOut>
  <NotExistsOrInvalidPassword>true</NotExistsOrInvalidPassword>
  <Success>true</Success>
  <UserID>f5339a7d-76d8-4563-8882-613544adc333</UserID>
</LoginResult>

multipart/form-data

Sample:

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

f5339a7d-76d8-4563-8882-613544adc333
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ApiKey"

1ce3c867-3f36-4338-b8d9-7af14268f547
--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="NotExistsOrInvalidPassword"

True
--MultipartDataMediaFormatterBoundary1q2w3e--