HostedSuite

<back to all web services

ListClientNamesRequest

Retrieve the entire list of client names and centers.

The following routes are available for this service:
POST/api/clients/names
ListClientNamesRequest Parameters:
NameParameterData TypeRequiredDescription
CenterIdbodystringNoFilter by center
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

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/clients/names HTTP/1.1 
Host: evo.hostedsuite.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

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

[{"Id":"String","DateLastModified":"String","Name":"String","CenterId":"String","CenterName":"String","ScreenPops":["String"],"Greeting":"String","CallInstructions":"String","PopupInformation":"String","Information":"String","FaxNumber":"String","CustomFields":[{"Name":"String","Value":"String"}],"Address":{"Street1":"String","Street2":"String","City":"String","State":"String","PostalCode":"String","Country":"String"},"ThirdPartyAccountId":"String","CallAllowanceType":"NotBillable","CallAllowanceAmount":0,"Links":[{"Id":"String","Name":"String","Url":"String"}],"IndustryId":"String","IndustryName":"String","Location":"String"}]