POST api/Authentication

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Username		string	None.
Password		string	None.

Request Formats

application/json, text/json

Sample:

{
  "username": "sample string 1",
  "password": "sample string 2"
}

application/xml, text/xml

Sample:

<AuthenticationRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Soprema.Website.ContractorPortal.WebApi.Models.RequestModels">
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
</AuthenticationRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AuthenticationResponseModel

Name	Type	Additional information
Success	boolean	None.
UserId	integer	None.
Username	string	None.
FirstName	string	None.
LastName	string	None.
CompanyId	integer	None.
CompanyNumber	string	None.
CompanyName	string	None.

Response Formats

application/json, text/json

Sample:

{
  "success": true,
  "userId": 2,
  "username": "sample string 3",
  "firstName": "sample string 4",
  "lastName": "sample string 5",
  "companyId": 6,
  "companyNumber": "sample string 7",
  "companyName": "sample string 8"
}

application/xml, text/xml

Sample:

<AuthenticationResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Soprema.Website.ContractorPortal.WebApi.Models.ResponseModels">
  <CompanyId>6</CompanyId>
  <CompanyName>sample string 8</CompanyName>
  <CompanyNumber>sample string 7</CompanyNumber>
  <FirstName>sample string 4</FirstName>
  <LastName>sample string 5</LastName>
  <Success>true</Success>
  <UserId>2</UserId>
  <Username>sample string 3</Username>
</AuthenticationResponseModel>