LocalitiesByName

<!-- 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 LocalitiesByName(licence, name) {
  /// <param name="licence">string. One of the following values: WebServerFull, WebClickFull, WebClickThoroughfare, InternalUserFull, InternalUserThoroughfare, SmallUserFull, Lookup, InternalServerFull, InternalServerThoroughfare, FreeTrial, FreeTrialThoroughfare</param>
  /// <param name="name">string</param>
  var addresscapture = new data8.addresscapture();
  
  addresscapture.localitiesbyname(
    licence,
    name,
    null,
    showLocalitiesByNameResult
  );
}

function showLocalitiesByNameResult(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>

// NOTE: A reference to the web service must be added in Visual Studio with the URL
// http://webservices.data-8.co.uk/AddressCapture.asmx
private void LocalitiesByName(AddressCaptureLicence licence, string name)
{
    // Invoke the web service method.
    AddressCapture proxy = new AddressCapture();
    PartialAddressOutput results = proxy.LocalitiesByName("username", "password", licence, name, null);
    // Check that the call succeeded, and show the error message if there was a problem.
    if ((results.Status.Success == false))
    {
        MessageBox.Show(("Error: " + results.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.
    }
}

'NOTE: A reference to the web service must be added in Visual Studio with the URL
'http://webservices.data-8.co.uk/AddressCapture.asmx
Private Sub LocalitiesByName(ByVal licence As AddressCaptureLicence, ByVal name As String)
    'Invoke the web service method.
    Dim proxy As AddressCapture = New AddressCapture
    Dim results As PartialAddressOutput = proxy.LocalitiesByName("username", "password", licence, name, Nothing)
    'Check that the call succeeded, and show the error message if there was a problem.
    If (results.Status.Success Is false) Then
        MessageBox.Show(("Error: " + results.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.
    End If
End Sub

Public Sub LocalitiesByName(licence As String, name As String)
  Dim rs As ADODB.Recordset
  Set rs = New ADODB.Recordset
  rs.Open "http://webservices.data-8.co.uk/recordset.ashx?service=AddressCapture&method=LocalitiesByNameSimple" &
    "&username=your-username" &
    "&password=your-password" &
    "&licence=" & licence &
    "&name=" & name
  If rs.MoveFirst Then
    If rs.Fields(0).Name = "Success" And rs.Fields(0).Value = false Then
      MsgBox "Error: " & rs.Fields(1)
    Else
      'TODO: Process method results here.
      'Each result is available in a different row in the recordset.
      'Results can be extracted from the following fields:
      'ID
      'Description
    End If
  End If
End Sub

// NOTE: The php_soap.dll extension must be enabled in the php.ini file.
function LocalitiesByName($licence, $name)
{
  $params = array(
    "username" => "your-username",
    "password" => "your-password",
    "licence" => $licence,
    "name" => $name,
    "options" => $options
  );
  $client = new SoapClient("http://webservices.data-8.co.uk/AddressCapture.asmx?WSDL");
  $result = $client->LocalitiesByName($params);
  if ($result->LocalitiesByNameResult->Status->Success == 0)
  {
    echo "Error: " . $result->LocalitiesByNameResult->Status->ErrorMessage;
  }
  else
  {
    // TODO: Process method results here.
    // Results can be extracted from the following fields:
    // $result->LocalitiesByNameResult->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.
    //   NOTE: This field contains an array of items, but if it contains only one item,
    //   PHP may not recognise it as an array. To always extract the result of this
    //   field as an array, we recommend you always access it using the
    //   getArrayFromResponse method described at
    //   http://www.php.net/soap_soapclient_soapcall#75797, e.g.
    //   foreach (getArrayFromResponse($result->LocalitiesByNameResult->Results) as $item)
    //   {
    //     ...
    //   }
  }
}