POST User/authenticate

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
userName	string	Required
password	string	Required
code	string	None.

Request Formats

application/json, text/json

Sample:

{
  "userName": "sample string 1",
  "password": "sample string 2",
  "code": "sample string 3"
}

application/xml, text/xml

Sample:

<AuthenticateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.User">
  <code>sample string 3</code>
  <password>sample string 2</password>
  <userName>sample string 1</userName>
</AuthenticateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AuthenticateResponse

Name	Type	Additional information
token	globally unique identifier	None.
code	integer	None.
error	string	None.
UserID	integer	None.
IsEmployee	boolean	None.
expirationDateUtc	date	None.
APIVersion	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "UserID": 1,
  "IsEmployee": true,
  "expirationDateUtc": "2025-12-19T02:10:57.3026194-08:00",
  "APIVersion": 4,
  "token": "a629aa52-83a8-4993-9497-a5375b1023b1",
  "code": 200,
  "error": "sample string 2"
}

application/xml, text/xml

Sample:

<AuthenticateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.User">
  <APIVersion xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">4</APIVersion>
  <error xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">sample string 2</error>
  <IsEmployee>true</IsEmployee>
  <UserID>1</UserID>
  <expirationDateUtc>2025-12-19T02:10:57.3026194-08:00</expirationDateUtc>
  <token>a629aa52-83a8-4993-9497-a5375b1023b1</token>
</AuthenticateResponse>