POST papi/v1/AuthenticateUser


Security

Anonymous API


Request Information

URI Parameters

None.

Required Headers

Name Description Sample Type Default
ConsumerId Represents the value of the consumer id.
Allow multiple values: no. 		2426 integer None

Optional Headers

Name Description Sample Type Default
ApplicationType Represents the value of the consumer's application type.
Allow multiple values: no. 		1 ApplicationType None
Accept-Language Represents the value of the desired language for translations.
Allow multiple values: yes. 		es string en

Body Parameters

WebUserAuthRequest
NameDescriptionTypeAdditional information
UserName

string

None.
Password

string

None.
LoginAttempt

integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "UserName": "sample string 1",
  "Password": "sample string 2",
  "LoginAttempt": 3
}

application/xml, text/xml

Sample: 
<WebUserAuthRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <UserName>sample string 1</UserName>
  <Password>sample string 2</Password>
  <LoginAttempt>3</LoginAttempt>
</WebUserAuthRequest>

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


Response Information

Resource Description

WebUserAuthResponse
NameDescriptionTypeAdditional information
Type

string

None.
Message

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Type": "sample string 1",
  "Message": "sample string 2"
}

application/xml, text/xml

Sample: 
<WebUserAuthResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Type>sample string 1</Type>
  <Message>sample string 2</Message>
</WebUserAuthResponse>