Get a Paged List of Contacts By Account Type
Retrieve a list of contacts by account type
Query String Parameters
Name | Type | Description | Required |
---|---|---|---|
Action | String | ContactListByAccountTypePaged | Required |
AccountType | Int | The unique identifier of the contact note group which can be retrieved using Contact Groups | Optional |
Page | Int | Page number. | Optional |
PageSize | Int | The number of rows to be included in each page. Allowed Values: 1 - 1000. | Optional |
IncludeExtra | bool | Include ContactExtra data items. 1 = true, 0 = false (default). | Optional |
Response Codes
Code | Message | Information |
---|---|---|
0 | Response Data | See 'Response' example tab |
2 | AccountType parameter required | Mandatory parameter was not supplied |
2 | No matching contact | No data returned or set-up in BigChange |
2 | Page parameter required | Mandatory parameter was not supplied |
2 | Pagesize parameter required | Mandatory parameter was not supplied |
2 | Maximum PageSize 5000 | PageSize value > 5000 |
2 | misc_noRight | You do not have the permissions to view contacts. |
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=ContactListByAccountTypePaged&AccountType=117324&Page=0&PageSize=5
Response Data
{ "Code": 0, "Result": [ { "Id": 9521601, "GroupId": 42923, "Name": "gsb contact 2", "Street": "Somewhere Street", "PostCode": "AB1 2CD", "Town": "Leeds", "Person": "", "Phone": null, "Email": null, "Extra": "", "Lat": 13.79154, "Lng": -3.55495, "Flagged": false, "ParentId": null, "contactParentReference": null, "ContactReference": null, "OnStop": 0 }, { "Id": 16155891, "GroupId": 16596, "Name": "GSB Import 8", "Street": "Anywhere Grange", "PostCode": "EF3 4GH", "Town": "", "Person": "", "Phone": null, "Email": null, "Extra": null, "Lat": 23.26199, "Lng": -5.86409, "Flagged": false, "ParentId": null, "contactParentReference": null, "ContactReference": null, "OnStop": 0 } ] }