POST api/v1/login

Authenticate user

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
UserName		string	Required
Password		string	Required

Request Formats

application/json, text/json

Sample:

{
  "UserName": "email@example.com",
  "Password": "password"
}

application/xml, text/xml

Sample:

<Credentials xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FreedomVoice.WebLink.Models">
  <Password>password</Password>
  <UserName>email@example.com</UserName>
</Credentials>

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 'Credentials'.

Response Information

Resource Description

200 status code will be returned for successful authentication. 400 status code will be returned if username is not a properly formatted email or phone number or if password is not provided. 401 status code will be returned for invalid credential combinations.

None.