FindAddress
 

FindAddress

Definition

PartialAddress[] FindAddress ( string username, string password, AddressCaptureLicence licence, string town, string street, string building, Option[] options )

Description:

Finds a list of possible addresses that match the search criteria. The search is performed by using the town, street and building parameters. The town parameter is required, and at least one of the street and building parameters must also be specified.

This method provides the easiest alternative for finding an address if the postcode is not known. If the postcode is known, use the GetFullAddress method instead.

If only the town and street parameters are specified, the method will return a list of every address known in that street. If only the town and building parameters are specified, the method will search for every address with that building name in the town, regardless of the street. For best performance, all three parameters should be specified where possible.

View all Postcode Lookup Methods

Code Samples

Language:

<!-- Import the Integr8 Ajax API -->
<!-- NOTE: Get your own API key to use in the following script tag from: -->
<!-- http://www.data-8.co.uk/integr8/Admin/Ajax.aspx -->
<script src="http://webservices.data-8.co.uk/Javascript/Loader.ashx?key=your-api-key" type="text/javascript">
</script>

<script type="text/javascript">

function loadIntegr8() {
  // Load the AddressCapture Integr8 service
  data8.load('AddressCapture');
}

function FindAddress(licence, town, street, building) {
  /// <param name="licence">string. One of the following values: WebServerFull, WebClickFull, WebClickThoroughfare, InternalUserFull, InternalUserThoroughfare, SmallUserFull, Lookup, InternalServerFull, InternalServerThoroughfare, FreeTrial, FreeTrialThoroughfare</param>
  /// <param name="town">string</param>
  /// <param name="street">string</param>
  /// <param name="building">string</param>
  var addresscapture = new data8.addresscapture();
  
  addresscapture.findaddress(
    licence,
    town,
    street,
    building,
    null,
    showFindAddressResult
  );
}

function showFindAddressResult(result) {
  // Check that the call succeeded, and show the error message if there was a problem.
  if (!result.Status.Success) {
    alert('Error: ' + result.Status.ErrorMessage);
  }
  else {
    // TODO: Process method results here.
    // Results can be extracted from the following fields:
    // result.Results
    //   Contains an array of addresses or partial address details that match the query.
    //   A human-readable description of each item in the array is available in the Description field,
    //   and an identifier to be passed to other methods is available in the ID field.
  }
}

loadIntegr8();

</script>
Skip Navigation Links
Request handled by server S2 for client 38.107.191.84 at 22/03/2010 02:18:43