HostedSuite

<back to all web services

AuthenticateRequest

The following routes are available for this service:
POST/api/authenticate
RequestBase<TResponse> Parameters:
NameParameterData TypeRequiredDescription
CustomerNameformstringYesThe HostedSuite Customer Name
UserNameformstringYesThe HostedSuite User Name. Data visibility and security is based on this user's permissions.
PasswordformstringYesThe HostedSuite User's Password
UserInfo Parameters:
NameParameterData TypeRequiredDescription
AuthenticatedformboolNo
UserTypeformstringNo
AlertformstringNo
NameformstringNo
CompanyNameformstringNo
UserIdformstringNo
ClientIdformstringNo
PhotoUrlformstringNo
UserInfo Parameters:
NameParameterData TypeRequiredDescription
AuthenticatedformboolNo
UserTypeformstringNo
AlertformstringNo
NameformstringNo
CompanyNameformstringNo
UserIdformstringNo
ClientIdformstringNo
PhotoUrlformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/authenticate HTTP/1.1 
Host: evo.hostedsuite.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AuthenticateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Evo.HostedSuite.Core.ServiceModel">
  <CustomerName>String</CustomerName>
  <Password>String</Password>
  <UserName>String</UserName>
</AuthenticateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Evo.HostedSuite.Core.ServiceModel">
  <Alert>String</Alert>
  <Authenticated>false</Authenticated>
  <ClientId>String</ClientId>
  <CompanyName>String</CompanyName>
  <Name>String</Name>
  <PhotoUrl>String</PhotoUrl>
  <UserId>String</UserId>
  <UserType>String</UserType>
</UserInfo>