ValidatePostcode

Definition


ValidatePostcodeResult ValidatePostcode (
  string username,
  string password,
  AddressCaptureLicence licence,
  string postcode
)

ValidatePostcodeResult {
  bool IsValid,
  string Formatted
}

Description:

Checks if a postcode is syntactically valid, and returns the same postcode in a standard format suitable for printing as part of an address.

This method does not check whether an address actually exists at the postcode, only that the postcode is of the correct format.

If the postcode has a correct format, the IsValid part of the result is set to true and the Formatted part of the result is set to the same postcode in a standard format, e.g. "ch652hq" is converted to "CH65 2HQ".

If the postcode does not have a correct format, the IsValid part of the result is set to false and the Formatted part of the result will not be specified.

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

function showValidatePostcodeResult(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.IsValid
    //   Indicates if the postcode is valid or not.
    // result.Formatted
    //   Contains a correctly formatted version of the supplied postcode.
  }
}

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 ValidatePostcode(AddressCaptureLicence licence, string postcode)
{
    // Invoke the web service method.
    AddressCapture proxy = new AddressCapture();
    ValidatePostcodeOutput results = proxy.ValidatePostcode("username", "password", licence, postcode, 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.IsValid
        //   Indicates if the postcode is valid or not.
        // result.Formatted
        //   Contains a correctly formatted version of the supplied postcode.
    }
}

'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 ValidatePostcode(ByVal licence As AddressCaptureLicence, ByVal postcode As String)
    'Invoke the web service method.
    Dim proxy As AddressCapture = New AddressCapture
    Dim results As ValidatePostcodeOutput = proxy.ValidatePostcode("username", "password", licence, postcode, 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.IsValid
        '  Indicates if the postcode is valid or not.
        'result.Formatted
        '  Contains a correctly formatted version of the supplied postcode.
    End If
End Sub

Public Sub ValidatePostcode(licence As String, postcode 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=ValidatePostcodeSimple" &
    "&username=your-username" &
    "&password=your-password" &
    "&licence=" & licence &
    "&postcode=" & postcode
  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.
      'All the results are available in the first row in the recordset.
      'Results can be extracted from the following fields:
      'IsValid
      '  Indicates if the postcode is valid or not.
      'Formatted
      '  Contains a correctly formatted version of the supplied postcode.
    End If
  End If
End Sub

// NOTE: The php_soap.dll extension must be enabled in the php.ini file.
function ValidatePostcode($licence, $postcode)
{
  $params = array(
    "username" => "your-username",
    "password" => "your-password",
    "licence" => $licence,
    "postcode" => $postcode,
    "options" => $options
  );
  $client = new SoapClient("http://webservices.data-8.co.uk/AddressCapture.asmx?WSDL");
  $result = $client->ValidatePostcode($params);
  if ($result->ValidatePostcodeResult->Status->Success == 0)
  {
    echo "Error: " . $result->ValidatePostcodeResult->Status->ErrorMessage;
  }
  else
  {
    // TODO: Process method results here.
    // Results can be extracted from the following fields:
    // $result->ValidatePostcodeResult->IsValid
    //   Indicates if the postcode is valid or not.
    // $result->ValidatePostcodeResult->Formatted
    //   Contains a correctly formatted version of the supplied postcode.
  }
}