Get a Contact by Postcode

Search Contacts using PostCode.

Query String Parameters

Name	Type	Description	Required
Action	String	ContactDetailByPostCode	Required
ContactPostCode	String	The postcode associated with the Contact that you want to search for.	Required
ContactParentId	Int	The ID of the parent contact. Use this parameter to filter results to only show contacts that match both the specified postcode and the contact parent. This narrows the search criteria.	Optional
ContactId	Int	The unique ID of the contact. Use this parameter to filter results to only show contacts that match both the specified postcode and the contact ID. This ensures precise search results.	Optional

Response Codes

Code	Message	Information
0	Response Data	See 'Response' example tab
2	Missing Parameter - contactPostCode	Mandatory parameter was not supplied
2	Invalid ContactParentId parameter.	Integer value is invalid or was not specified (when required)
2	Invalid ContactId parameter.	Integer value is invalid or was not specified (when required)
2	No contacts found	No data returned or set-up in BigChange
2	misc_noRight	You do not have the permissions to view contacts.

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=contactdetailbypostcode&contactpostcode=XX15 7XS

Response

Response Data

{
  "Code": 0,
  "Result": [
    {
      "Id": 7348490,
      "GroupId": 14971,
      "Name": "Joe Bloggs",
      "Street": "18 Somewhere Close",
      "PostCode": "XX15 7XS",
      "Town": "",
      "Country": "",
      "Person": "Primary Person",
      "Phone": "",
      "Email": "",
      "Extra": "",
      "Lat": 5.56373,
      "Lng": -0.922037,
      "Flagged": false,
      "ParentId": 5930839,
      "ParentFlagged": false,
      "ParentName": "Joe Bloggs Parent",
      "ParentPerson": "Joe Bloggs",
      "ParentPhone": "+447777123456",
      "ContactReference": "JOEB0001",
      "ParentReference": "JOEB0002",
      "AccountReference": "JOEB0001",
      "AccountType": 1,
      "FlaggedReason": "",
      "ParentFlaggedReason": "",
      "OnStop": 0,
      "OnStopReason": "",
      "OnStopDate": null,
      "OnStopUserId": null,
      "ContactExtraDelay2Pay": 0,
      "ContactExtraQuoteValidity": null,
      "Cust_System_Resource": "{\"id\":108103,\"label\":\" Joe Bloggs\",\"type\":\"0\"}",
      "PersonUid": "746dcb59-759e-481d-85a9-1ed094377d60"
    },
    {
      "Id": 30966833,
      "GroupId": 14971,
      "Name": "Joe Bloggs Limited",
      "Street": "21 Somewhere Close",
      "PostCode": "XX15 7XS",
      "Town": "Somewhere",
      "Country": "United Kingdom",
      "Person": "Joe Bloggs",
      "Phone": "+7788990011",
      "Email": "",
      "Extra": null,
      "Lat": 5.38943,
      "Lng": -0.74213,
      "Flagged": false,
      "ParentId": null,
      "ParentFlagged": false,
      "ParentName": null,
      "ParentPerson": null,
      "ParentPhone": null,
      "ContactReference": "001-new-contact",
      "ParentReference": null,
      "AccountReference": null,
      "AccountType": null,
      "FlaggedReason": null,
      "ParentFlaggedReason": null,
      "OnStop": 1,
      "OnStopReason": "Terrible credit",
      "OnStopDate": "2023-08-03 01:00:00",
      "OnStopUserId": 25193,
      "ContactExtraDelay2Pay": null,
      "ContactExtraQuoteValidity": null,
      "OnStopUserName": "Joe Bloggs (Admin)",
      "PersonUid": "b6f9d16f-bc7d-427f-be25-ffa4b19fd191"
    }
  ]
}