Get a List of Contacts By ParentGroup and Reference
Retrieve a list of Contacts that have where their Contact Group Id and Contact Reference match the supplied parameters.
Query String Parameters
Name | Type | Description | Required |
---|---|---|---|
Action | String | ContactByGroupAndRef | Required |
ContactGroupId | Int | The unique identifier of the contact note group which can be retrieved using Contact Groups | Optional |
ContactReference | String(50) | The internal reference of the contact. | Optional |
Response Codes
Code | Message | Information |
---|---|---|
0 | Response Data | See 'Response' example tab |
2 | Missing or invalid parameter - contactGroupId | Mandatory parameter was not supplied Integer value is invalid or was not specified (when required) |
2 | Missing parameter - contactReference | Mandatory parameter was not supplied |
2 | No contacts found | No data returned or set-up in BigChange |
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=contactbygroupandref&contactgroupid=16503&contactReference=3172
Response Data
{ "Code": 0, "Result": [ { "ContactId": 1808532, "ContactGroupId": 16503, "ContactName": "Redacted Name", "ContactStreet": "Redacted Street", "ContactPostCode": "NE3 4NT", "ContactTown": "Newcastle Upon Tyne", "ContactCountry": "", "ContactPerson": "", "ContactEmail": "Redacted Email", "ContactExtra": "", "ContactFlagged": false, "ContactCenter": { "Latitude": 55.00518, "Longitude": -1.64232 }, "ContactOwnerId": 13526, "ContactOnStop": 0, "UpdateNow": false } ] }