Checks if a person can be found to be living at an address. If so, the service returns true. Otherwise, it returns false.
Note that a return value of false does not necessarily indicate that the person does not live at the address given. A person may
be opted-out of the edited electoral roll and may not appear on the other data sources used to supplement the electoral roll,
but may still be a resident at the address.
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 NameAppend Integr8 service
data8.load('NameAppend');
}
function ConfirmResidency(record) {
/// <param name="record">data8.inputrecord. Set up the Name, Address properties before calling this method.</param>
var nameappend = new data8.nameappend();
nameappend.confirmresidency(
record,
null,
showConfirmResidencyResult
);
}
function showConfirmResidencyResult(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.Result
// Indicates if the person has been verified to be living at the requested address.
// result.MatchLevel
// Indicates the match level that the person has been verified to be living at the requested address. Forename, Initial, Surname, Premise or None
}
}
loadIntegr8();
</script>
// NOTE: A reference to the web service must be added in Visual Studio with the URL
// http://webservices.data-8.co.uk/NameAppend.asmx
private void ConfirmResidency(InputRecord record)
{
// Invoke the web service method.
NameAppend proxy = new NameAppend();
ResidencyVerificationOutput results = proxy.ConfirmResidency("username", "password", record, 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.Result
// Indicates if the person has been verified to be living at the requested address.
// result.MatchLevel
// Indicates the match level that the person has been verified to be living at the requested address. Forename, Initial, Surname, Premise or None
}
}
'NOTE: A reference to the web service must be added in Visual Studio with the URL
'http://webservices.data-8.co.uk/NameAppend.asmx
Private Sub ConfirmResidency(ByVal record As InputRecord)
'Invoke the web service method.
Dim proxy As NameAppend = New NameAppend()
Dim results As ResidencyVerificationOutput = proxy.ConfirmResidency("username", "password", record, 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.Result
' Indicates if the person has been verified to be living at the requested address.
'result.MatchLevel
' Indicates the match level that the person has been verified to be living at the requested address. Forename, Initial, Surname, Premise or None
End If
End Sub
Public Sub ConfirmResidency(forename As String, middlename As String, surname As String, address As String)
Dim rs As ADODB.Recordset
Set rs = New ADODB.Recordset
rs.Open "http://webservices.data-8.co.uk/recordset.ashx?service=NameAppend&method=ConfirmResidencySimple" &
"&username=your-username" &
"&password=your-password" &
"&forename=" & forename &
"&middlename=" & middlename &
"&surname=" & surname &
"&address=" & address
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:
'Result
' Indicates if the person has been verified to be living at the requested address.
'MatchLevel
' Indicates the match level that the person has been verified to be living at the requested address. Forename, Initial, Surname, Premise or None
End If
End If
End Sub
// NOTE: The php_soap.dll extension must be enabled in the php.ini file.
function ConfirmResidency($record)
{
$params = array(
"username" => "your-username",
"password" => "your-password",
"record" => $record,
"options" => $options
);
$client = new SoapClient("http://webservices.data-8.co.uk/NameAppend.asmx?WSDL");
$result = $client->ConfirmResidency($params);
if ($result->ConfirmResidencyResult->Status->Success == 0)
{
echo "Error: " . $result->ConfirmResidencyResult->Status->ErrorMessage;
}
else
{
// TODO: Process method results here.
// Results can be extracted from the following fields:
// $result->ConfirmResidencyResult->Result
// Indicates if the person has been verified to be living at the requested address.
// $result->ConfirmResidencyResult->MatchLevel
// Indicates the match level that the person has been verified to be living at the requested address. Forename, Initial, Surname, Premise or None
}
}