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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"CustomerName":"String","UserName":"String","Password":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Authenticated":false,"UserType":"String","Alert":"String","Name":"String","CompanyName":"String","UserId":"String","ClientId":"String","PhotoUrl":"String"}