POST api/Common/User/LoginByCredential

Request Information

URI Parameters

None.

Body Parameters

UserCredential
NameDescriptionTypeAdditional information
Username

string

None.

Password

string

None.

RequestIPAddress

string

None.

RequestUserAgentString

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Username": "sample string 1",
  "Password": "sample string 2",
  "RequestIPAddress": "sample string 3",
  "RequestUserAgentString": "sample string 4"
}

application/xml, text/xml

Sample:
<UserCredential xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Timecut.Shared.Model.Common.User">
  <Password>sample string 2</Password>
  <RequestIPAddress>sample string 3</RequestIPAddress>
  <RequestUserAgentString>sample string 4</RequestUserAgentString>
  <Username>sample string 1</Username>
</UserCredential>

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

Response Information

Resource Description

UserLoginResponse
NameDescriptionTypeAdditional information
Success

boolean

None.

FailingCode

ErrorCodes

None.

RedirectUrl

string

None.

AuthenticationType

AuthenticationTypes

None.

Token

string

None.

System

string

None.

SystemMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "FailingCode": 0,
  "RedirectUrl": "sample string 2",
  "AuthenticationType": 0,
  "Token": "sample string 3",
  "System": "sample string 4",
  "SystemMessage": "sample string 5"
}

application/xml, text/xml

Sample:
<UserLoginResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Timecut.Shared.Model.Common.User">
  <AuthenticationType>None</AuthenticationType>
  <FailingCode>None</FailingCode>
  <RedirectUrl>sample string 2</RedirectUrl>
  <Success>true</Success>
  <System>sample string 4</System>
  <SystemMessage>sample string 5</SystemMessage>
  <Token>sample string 3</Token>
</UserLoginResponse>