| POST | /api/clients |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientId | body | string | No | ID of the client you want to filter by. When using this only a single result will be returned. |
| Name | body | string | No | Name of the client you want to filter by. |
| CenterId | body | string | No | Filter by center |
| ThirdPartyAccountId | body | string | No | Filter by third party account ID |
| ScreenPop | body | string | No | Filter by screen pop |
| CategoryIds | body | List<string> | No | List of category IDs that the client must have |
| CustomFieldsFilter | body | Dictionary<string, string> | No | Filter by custom fields |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerName | form | string | Yes | The HostedSuite Customer Name |
| UserName | form | string | Yes | The HostedSuite User Name. Data visibility and security is based on this user's permissions. |
| Password | form | string | Yes | The 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/clients HTTP/1.1
Host: cpo.hostedsuite.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"ClientId":"String","Name":"String","CenterId":"String","ThirdPartyAccountId":"String","ScreenPop":"String","CategoryIds":["String"],"CustomFieldsFilter":{"String":"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"}]