POST api/users/login

User authentication method

Request Information

Authentication

This method requires device authentication

URI Parameters

None.

Body Parameters

Market
NameDescriptionTypeAdditional information
MarketName

Market Name.

string

None.

C4Uid

Alphanumeric code for a particular market.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "MarketName": "sample string 1",
  "C4Uid": "sample string 2"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

UserToken
NameDescriptionTypeAdditional information
UserProfile

Complete logged in User Profile

User

None.

TokenType

Token Type

TokenType

None.

AccessToken

Access Token

string

None.

Response Formats

application/json, text/json

Sample:
{
  "TokenType": 0,
  "AccessToken": "sample string 1",
  "UserProfile": {
    "UserId": 1,
    "UserTypeId": 1,
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "Email": "sample string 4",
    "CellPhone": "sample string 5",
    "OtherPhone": "sample string 6",
    "Pager": "sample string 7",
    "Fax": "sample string 8",
    "Extension": "sample string 9",
    "TitleId": 1,
    "HomePhone": "sample string 10",
    "AlternateTitle": "sample string 11"
  }
}

Internal Error Codes

  • 106: ResourceNotFound
    (The requested resource was not found., NotFound)
  • 100: MissingRequiredHeader
    (Invalid request format. A required HTTP header was not specified., BadRequest)
  • 118: InvalidHeaderValue
    (The value provided for one of the HTTP headers was not in the correct format., BadRequest)
  • 199: UnknownError
    (Internal server error., InternalServerError)
  • 101: InvalidCredentials
    (Unable to verify your credentials., Unauthorized)