POST authenticate

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Username	string	None.
Password	string	None.
IsPortalAdmin	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Username": "sample string 1",
  "Password": "sample string 2",
  "IsPortalAdmin": true
}

text/html

Sample:

{"$id":"1","Username":"sample string 1","Password":"sample string 2","IsPortalAdmin":true}

application/xml, text/xml

Sample:

<AuthenticateViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AcePortal.Models.Authentication">
  <IsPortalAdmin>true</IsPortalAdmin>
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
</AuthenticateViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AuthenticationResponse

Name	Type	Additional information
Success	boolean	None.
CustomerId	integer	None.
LotNumber	string	None.
ProfileType	string	None.
Message	string	None.
EntityId	string	None.
CompanyId	string	None.
Username	string	None.
FirstName	string	None.
LastName	string	None.
EmailAddress	string	None.
IsIndividual	boolean	None.
IsParker	boolean	None.
IsPortalAdmin	boolean	None.
PortalRole	string	None.
DisplayName	string	None.
IdentificationString	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "CustomerId": 2,
  "LotNumber": "sample string 3",
  "ProfileType": "sample string 4",
  "Message": "sample string 5",
  "EntityId": "sample string 6",
  "CompanyId": "sample string 7",
  "Username": "sample string 8",
  "FirstName": "sample string 9",
  "LastName": "sample string 10",
  "EmailAddress": "sample string 11",
  "IsIndividual": false,
  "IsParker": false,
  "IsPortalAdmin": false,
  "PortalRole": "Individual Account",
  "DisplayName": "sample string 9",
  "IdentificationString": "A different account signed in"
}

text/html

Sample:

{"$id":"1","Success":true,"CustomerId":2,"LotNumber":"sample string 3","ProfileType":"sample string 4","Message":"sample string 5","EntityId":"sample string 6","CompanyId":"sample string 7","Username":"sample string 8","FirstName":"sample string 9","LastName":"sample string 10","EmailAddress":"sample string 11","IsIndividual":false,"IsParker":false,"IsPortalAdmin":false,"PortalRole":"Individual Account","DisplayName":"sample string 9","IdentificationString":"A different account signed in"}

application/xml, text/xml

Sample:

<AuthenticationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AcePortal.Domain.Models.MonthlyApi">
  <CompanyId>sample string 7</CompanyId>
  <CustomerId>2</CustomerId>
  <EmailAddress>sample string 11</EmailAddress>
  <EntityId>sample string 6</EntityId>
  <FirstName>sample string 9</FirstName>
  <LastName>sample string 10</LastName>
  <LotNumber>sample string 3</LotNumber>
  <Message>sample string 5</Message>
  <ProfileType>sample string 4</ProfileType>
  <Success>true</Success>
  <Username>sample string 8</Username>
</AuthenticationResponse>