POST api/v1/authenticate

Method to authenticate with Promotional Office

Request Information

URI Parameters

None.

Body Parameters

Model that requires the login information

Name	Description	Type	Additional information
Company	Companyname of the company you're trying to login into	string	None.
Username	Username of the account you're trying to use	string	None.
Password	Password of the account	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Company": "sample string 1",
  "Username": "sample string 2",
  "Password": "sample string 3"
}

application/xml, text/xml

Sample:

<AuthenticateRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PromotionalOffice.WebApi.Models.Authentication">
  <Company>sample string 1</Company>
  <Password>sample string 3</Password>
  <Username>sample string 2</Username>
</AuthenticateRequestModel>

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

Response Information

Resource Description

Token

AuthenticationResponseModel

Name	Description	Type	Additional information
Token	Secret token that is linked to your identity	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Token": "sample string 1"
}

application/xml, text/xml

Sample:

<AuthenticationResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PromotionalOffice.WebApi.Models.ResponseModel">
  <Token>sample string 1</Token>
</AuthenticationResponseModel>