The AFD Postcode Plus for Android API is easy to use and quick to implement in any Android application, while balancing that with providing full flexibility. A JAR file (afdpcp.jar) alongside our native library (libafdpcp.so) provides access to Postcode Plus functionality once added to your project.
For rapid development and for a quick start, take a look at our sample program here to see how Postcode Plus is integrated. When you run that on Android you will need to copy your licence file to your chosen data folder on the device (unless using evaluation data). The data files (pcplus.afd, pcplusi.afd, etc.) will also need to be present either along with your application or on external storage. If file transfer is more difficult, you can simplify this by transfering the licence file using the SaveLicense method and obtain the latest data files automatically using the update functionality.
To integrate Postcode Plus into your own Project simply add the afdpcp.jar file to your project libs folder and the libafdpcp.so to libs\armeabi. Then create an instance of the afd.pcp.Engine class to access AFD Postcode Plus functionality.
On creating an instance of the afd.pcp.Engine class you should pass the path to access the product data files from, for example for application private storage:
Engine pcpEngine = new afd.pcp.Engine(getFilesDir());
Or for an example of an external path:
Engine pcpEngine = new afd.pcp.Engine(“/mnt/sdcard/pcpdata/”);
For non-evaluation purposes we recommend using the automatic update functionality to obtain the latest data files and using the saveLicense method to save the licence from a Base64 encoded string.
A sample application demonstrating AFD Postcode Plus functionality is provided with the SDK.
To use this load the project in Eclipse and then click Run and follow any prompts to start the application on your device.
The path to the data folder is set in the top of the common.java and is displayed on the FastFind screen of the sample application. You may need to change this to point to an appropriate location for your target device.
For Evaluation data, copy that data to a folder on the device, or include it in your apk and ensure you have set the data path correctly as above.
For Full data, either transfer the nn.lic licence file to the device or use the saveLicense method to generate the file from a Base64 string that AFD will have supplied. Then use the checkForUpdates function to obtain the latest data.
The addressGetFirst and addressGetNext methods enable address records to quickly be located.
This is typically done as follows:
See the appropriate function and property references for full details of these methods and properties.
An example lookup is as follows:
// Create an instance of the afd.pcp.Engine class
Engine pcp Engine = new afd. pcp.Engine();
// Set the search criteria
pcpEngine.clear();
pcpEngine.setSearchLookup("B6 4AA");
// Do the lookup
int retVal = pcpEngine.addressGetFirst(0);
// Deal with any error
if (retVal < 0) {
AlertDialog.Builder dlgAlert = new AlertDialog.Builder(this);
dlgAlert.setTitle("Error");
dlgAlert.setMessage(pcpEngine.errorText(retVal));
dlgAlert.create().show();
return;
}
// Retrieve the results
while (retVal >= 0) {
if (retVal != pcpEngine.AFD_RECORD_BREAK) {
String listItem = pcpEngine.getAddressList();
// do something with this data
}
retVal = pcpEngine.addressGetNext();
}
The jumpToRecord method enables records to be quickly retrieved again, (from a list displayed to the user, for example) using its record key.
This is typically done as follows:
See the appropriate function and property references for full details of this method and properties.
An example retrieve is as follows, where recordKey is the result of calling getRecordKey for the record originally retrieved:
// Create an instance of the afd.pcp.Engine class
Engine pcp Engine = new afd.pcp.Engine();
// Do the lookup
int retVal = pcp Engine.jumpToRecord(recordKey);
// Deal with any error
if (retVal < 0) {
AlertDialog.Builder dlgAlert = new AlertDialog.Builder(this);
dlgAlert.setTitle("Error");
dlgAlert.setMessage(pcpEngine.errorText(retVal));
dlgAlert.create().show();
return;
}
// Retrieve the result
String organisation = pcpEngine.getOrganisation();
String property = pcpEngine.getProperty();
String street = pcpEngine.getStreet();
String locality = pcpEngine.getLocality();
String town = pcpEngine.getTown();
String postcode = pcpEngine.getPostcode();
// do something with this data
To use full data with AFD Postcode Plus, a License will need to be purchased from AFD. This is provided in two forms, a file nn.lic and a Base64 encoded version to make entry or transfer easier.
Either save the pcplus.lic file in your data folder, or use the saveLicense method to pass the supplied base64 encoded text string to apply the license.
The process to do this is typically as follows:
An example of doing this is as follows:
int applied = pcpEngine.saveLicense(licenseString);
if (applied == 1) {
// success
}
else {
// license string not valid
}
To update Postcode Plus data, the data files (pcplus.afd, pcplusi.afd, etc.) need to be replaced in your data folder with the latest versions available from our server.
This can be done automatically using instance functions of the afd.pcp.Engine class provided for updating.
The process to do this is typically as follows:
An example of doing this is as follows:
int needUpdate = afd.pcp.Engine.checkForUpdate();
if (needUpdate == 1) {
int startedDownload = afd. pcp.Engine.downloadUpdate();
if (startedDownload == 1) {
while (afd. pcp.Engine.isDownloadComplete() == 0) {
// wait for download to complete – can carry on with other
tasks
}
int updateApplied = afd.pcp.Engine.applyUpdate();
}
Clears the search properties ready to start a new search
public void clear();
This function takes no parameters and returns no value.
Starts a lookup or search and returns the first record
Prior to calling this function, call Clear and set the appropriate search parameters to specify the fields you wish to search for (e.g. setSearchLookup).
public int addressGetFirst(int flags)
flags is an integer and specifies options for the search. These are as follows:
The function returns one of the following values:
If AFD_SUCCESS is returned you can then call any of the properties to obtain the fields for the returned record, e.g. getAddressList.
If AFD_SUCCESS or AFD_RECORD_BREAK is returned you should call addressGetNext to retrieve each subsequent record until AFD_END_OF_SEARCH is returned.
Continues a lookup or search, returning the next matching record
public int addressGetNext()
This function takes no parameters.
The function returns one of the following values:
If AFD_SUCCESS is returned you can then call any of the properties to obtain the fields for the returned record, e.g. getAddressList.
If AFD_SUCCESS or AFD_RECORD_BREAK is returned you should continue to call AddressGetNext to retrieve each subsequent record until AFD_END_OF_SEARCH is returned.
Returns data for the record key supplied
public int jumpToRecord(String recordKey)
The recordKey parameter is the key of the record to be retrieved. This would have been returned by using the getRecordKey method following a previous call to AddressGetFirst or AddressGetNext. Note this key should not be stored as it is not maintained across data updates; it is designed for reretrieving a record following a list being provided to the user.
The function returns one of the following values:
If AFD_SUCCESS is returned, any of the properties can then be called to obtain the fields for the returned record, e.g. getStreet.
Used to retrieve text to display a friendly error message to go with an error code returned from the search or validation functions (return value less than zero).
public String errorText(int errorCode)
errorCode is an int and should be set to the return value from a previous function call.
On return a description for the error is returned which can be stored or displayed for the user.
Used to save a license file on the device from a Base64 encoded string representation.
public int saveLicense(string base64License)
Base64License is the string containing the base64 encoded license data.
Returns:
Used to check if an update to the Postcode Plus data files is available.
public int checkForUpdate()
Returns:
Used to start downloading a data update.
public int downloadUpdate()
Returns:
When the function returns data continues to download in the background so your application can continue running. Poll with IsDownloadComplete periodically to determine when the download has finished.
Used to indicate when a data download has completed downloading
public int isDownloadComplete()
Returns:
Used to update data files following a successful download and loads the new dataset.
public int applyUpdate()
Returns:
Note that you mustn’t call the Postcode Plus functions while this call is completing as old data will be unloaded, the new data unpacked and then loaded during this call. Hence this call does block the thread it is called on which is assumed to be the one you carry out Postcode Plus calls on.
Getter methods are provided to set properties for searches and setter methods to get the resulting record details following a match. These are as follows:
| Field Name | Description |
|---|---|
| Search Fields (Any of these can be set prior to a call to AddressGetFirst) | |
| setSearchLookup | Specify fast-find string to look for, e.g. a postcode or street, town. No other search fields should be set when this is used. |
| setSearchPostcodeFrom | Set Postcode to search from (range) |
| setSearchPostcodeTo | Set Postcode to search to (range) |
| setSearchOrganisation | Set Organisation Name to search for |
| setSearchProperty | Set Property or Building Name to search for |
| setSearchStreet | Set Street Name to search for |
| setSearchLocality | Set Locality name to search for |
| setSearchTown | Set Post Town to search for |
| setSearchCounty | Set County Name to search for (searches all county types) |
| setSearchSTDCode | Set Dialling Code to search for |
| setSearchGridE | Set Grid Easting to search around (for radial searches) |
| setSearchGridN | Set Grid Northing to search around (for radial searches) |
| setSearchMiles | Set distance in miles to search around (for radial searches) |
| setSearchKm | Set distance in kilometres to search around |
| setSearchJustBuilt | Set Just Built date to search for (in format YYYYMMDD) |
| setSearchUDPRN | Set UDPRN to search for. No other search fields should be set when this is used. |
| Formatted Address Fields | |
| getRecordKey | Returns a record key to use for subsequent retrieval of the record with AddressRetrieve. Note this should not be stored as it does not persist across data updates. |
| getPostcode | Returns the Postcode |
| getPostcodeFrom | Returns the original postcode if the postcode searched for has been changed (re-coded). |
| getOrganisation | Returns the Organisation Name |
| getProperty | Returns the Building Name |
| getStreet | Returns the House Number and Street Name |
| getLocality | Returns the Locality Name |
| getTown | Returns the Post Town for this address |
| getAddressList | Returns a formatted line for list insertion containing elements of the Address record. Useful when displaying a list of results for the user to choose from. |
| Raw Address Fields (unformatted with house number in a separate field) | |
| getPAFDepartment | The department name |
| getPAFOrganisation | The organisation name |
| getPAFSubBuilding | The sub building name |
| getPAFBuilding | The building name |
| getPAFNumber | Property number |
| getPAFPOBox | PO Box number |
| getPAFDepStreet | The dependent street name |
| getPAFStreet | The street name |
| getPAFDblDepLoc | The double dependent locality name |
| getPAFDepLoc | The dependent locality name |
| County Fields | |
| getCountyPostal | Postal County (held by Royal Mail) |
| getCountyOptional | Postal Counties including optional ones (no longer held by Royal Mail) |
| getCountyAbbreivatedPostal | Postal County, abbreviated were an official abbreviation exists |
| getCountyAbbreviatedOptional | Optional County, abbreviated were an official abbreviation exists |
| getCountyTraditional | Traditional County Name |
| getCountyAdministrative | Administrative County Name |
| Additional Postal Fields | |
| getDPS | The Delivery Point Suffix which along with the postcode uniquely identifies the letterbox for this address. |
| getPostcodeFrom | Returns the original postcode if the postcode searched for has been changed (re-coded). |
| getPostcodeType | L for Large User Postcode, S for Small User. |
| getMailsortCode | Used for obtaining bulk mail discounts. |
| getUDPRN | Royal Mail Unique Delivery Point Reference Number assigned to this letter box. |
| getJustBuilt | AFDJustBuilt – Contains the date of inclusion on PAF for properties thought to be recently built. The date is stored numerically in descending format in the form YYYYMMDD. YYYY is the year, MM is the month and DD is the day. For example 20080304 is 04/03/2008. |
| getHouseholds | Number of households behind the delivery point |
| Geographical Fields | |
| getGridE | Grid Easting as a 6 digit reference |
| getGridN | Grid Northing as a 6/7 digit reference |
| getLatitude | Latitude representation of Grid Reference in Decimal Format (WGS84) |
| getLongitude | Longitude representation of Grid Reference in Decimal |
| Format (WGS84) | getUrbanRuralCode Provides a code which indicates if an area is mainly urban or rural and how sparsely populated those area’s are. [3] |
| getUrbanRuralName | Provides a description which goes along with the UrbanRuralCode. [3] |
| getSOALower | Lower level Super Output Area (Data Zone in Scotland, Super Output Area in Northern Ireland) |
| getSOAMiddle | Middle level Super Output Area (Intermediate Geography in Scotland, not applicable for Northern Ireland). |
| getSubCountryName | Indicates if the postcode falls within the boundary of England, Wales, Scotland, Northern Ireland, Isle of Man, Jersey or Guernsey |
| Phone Related | |
| getSTDCode | Returns an indication of the most likely Standard Dialing Code for this postcode |
| Administrative Fields | |
| getWardCode | Code identifying the electoral ward for this postcode |
| getWardName | Name identifying the electoral ward for this postcode |
| getAuthorityCode | Local/Unitary Authority for this Postcode (same as the start of the ward code). |
| getAuthorityName | Local / Unitary Authority for this postcode |
| getConstituencyCode | Code for the Parliamentary Constituency for this postcode |
| getConstituencyName | Name of the Parliamentary Constituency for this postcode |
| getDevolvedConstituencyCode | Code for the Scottish Parliamentary Constituency for this postcode (if applicable) |
| getDevolvedConstituencyName | Name of the Scottish Parliamentary Constituency for this postcode (if applicable) |
| getEERCode | Code identifying the European Electoral Region for this postcode |
| getEERName | Name identifying the European Electoral Region for this postcode |
| getLEACode | Code identifying the Local Education Authority for this postcode |
| getLEAName | Name identifying the Local Education Authority for this postcode |
| getTVRegion | ISBA TV Region (not TV Company) |
| Postcode Level Property Indicator Fields | |
| getOccupancy | Indication of the type of occupants of properties found on the selected postcode [1] |
| getAddressType | Indication of the type of property level data to capture to have the full address for a property on the selected postcode. [2] |
| NHS Fields | |
| getCCGCode | Clinical Commissioning Group Code (Local Health Board Code in Wales, Community Health Partnership in Scotland, and Health and Social Services Boards in Northern Ireland) |
| getCCGName | Name matching the CCG Code field |
| getSHACode | Strategic Health Authority Code |
| getSHAName | Strategic Health Authority Name |
| getNHSRegionCode | National Health Service Region Code |
| getNHSRegionName | National Health Service Region Name |
| Censation Fields | |
| getCensationCode | Censation Code assigned to this Postcode |
| getCensationLabel | Label for this Censation group for ease of identification and reference. |
| getAffluence | Affluence description |
| getLifeStage | LifeStage description |
| getAdditionalCensusInfo | Additional information derived from the Census. |
[1] Possible Occupancy values and descriptions are as follows (information in brackets not part of the description):
[2] Possible Address Type values and descriptions are as follows (information in brackets not part of the description):
[3] The Urban Rural Code differs from England and Wales, Scotland and Northern Ireland. The possible codes and there meanings are as follows:
England & Wales
Scotland
Northern Ireland
A – E (Urban):
F – H (Rural):
The AFD Names & Numbers for Android API is easy to use and quick to implement in any Android application, while balancing that with providing full flexibility. A JAR file (afdnn.jar) alongside our native library (libafdnn.so) provides access to Names & Numbers functionality once added to your project.
For rapid development and for a quick start, take a look at our sample program here to see how Names & Numbers is integrated. When you run that on Android you will need to copy your licence file to your chosen data folder on the device (unless using evaluation data). The data files (names.afd, namesi.afd, etc.) will also need to be present either along with your application or on external storage. If file transfer is more difficult, you can simplify this by transfering the licence file using the SaveLicense method and obtain the latest data files automatically using the update functionality.
To integrate Names & Numbers into your own Project, simply add the afdnn.jar file to your project libs folder and the libafdnn.so to libs\armeabi. Then create an instance of the afd.nn.Engine class to access AFD Names & Numbers functionality.
On creating an instance of the afd.nn.Engine class you should pass the path to access the product data files from, for example for application private storage:
Engine nnEngine = new afd.nn.Engine(getFilesDir());
Or for an example of an external path:
Engine nnEngine = new afd.nn.Engine(“/mnt/sdcard/nndata/”);
For non-evaluation purposes we recommend using the automatic update functionality to obtain the latest data files and using the saveLicense method to save the licence from a Base64 encoded string.
A sample application demonstrating AFD Names & Numbers functionality is provided with the SDK.
To use this load the project in Eclipse and then click Run and follow any prompts to start the application on your device.
The path to the data folder is set in the top of the common.java and is displayed on the FastFind screen of the sample application. You may need to change this to point to an appropriate location for your target device.
For Evaluation data, copy that data to a folder on the device, or include it in your apk and ensure you have set the data path correctly as above.
For Full data, either transfer the nn.lic licence file to the device or use the saveLicense method to generate the file from a Base64 string that AFD will have supplied. Then use the checkForUpdates function to obtain the latest data.
The addressGetFirst and addressGetNext methods enable address records to quickly be located.
This is typically done as follows:
See the appropriate function and property references for full details of these methods and properties.
An example lookup is as follows:
// Create an instance of the afd.nn.Engine class
Engine nnEngine = new afd.nn.Engine();
// Set the search criteria
nnEngine.clear();
nnEngine.setSearchLookup("B6 4AA");
// Do the lookup
int retVal = nnEngine.addressGetFirst(0);
// Deal with any error
if (retVal < 0) {
AlertDialog.Builder dlgAlert = new AlertDialog.Builder(this);
dlgAlert.setTitle("Error");
dlgAlert.setMessage(nnEngine.errorText(retVal));
dlgAlert.create().show();
return;
}
// Retrieve the results
while (retVal >= 0) {
if (retVal != nnEngine.AFD_RECORD_BREAK) {
String listItem = nnEngine.getAddressList();
// do something with this data
}
retVal = nnEngine.addressGetNext();
The jumpToRecord method enables records to be quickly retrieved again, (from a list displayed to the user, for example) using its record key.
This is typically done as follows:
See the appropriate function and property references for full details of this method and properties.
An example retrieve is as follows, were recordKey is the result of calling getRecordKey for the record originally retrieved:
// Create an instance of the afd.nn.Engine class
Engine nnEngine = new afd.nn.Engine();
// Do the lookup
int retVal = nnEngine.jumpToRecord(recordKey);
// Deal with any error
if (retVal < 0) {
AlertDialog.Builder dlgAlert = new AlertDialog.Builder(this);
dlgAlert.setTitle("Error");
dlgAlert.setMessage(nnEngine.errorText(retVal));
dlgAlert.create().show();
return;
}
// Retrieve the result
String organisation = nnEngine.getOrganisation();
String property = nnEngine.getProperty();
String street = nnEngine.getStreet();
String locality = nnEngine.getLocality();
String town = nnEngine.getTown();
String postcode = nnEngine.getPostcode();
// do something with this data
To use full data with AFD Names & Numbers, a License will need to be purchased from AFD. This is provided in two forms, a file nn.lic and a Base64 encoded version to make entry or transfer easier.
Either save the nn.lic file in your data folder, or use the saveLicense method to pass the supplied base64 encoded text string to apply the license.
The process to do this is typically as follows:
An example of doing this is as follows:
int applied = nnEngine.saveLicense(licenseString);
if (applied == 1) {
// success
}
else {
// license string not valid
}
To update Names & Numbers data, the data files (names.afd, namesi.afd, etc.) need to be replaced in your data folder with the latest versions available from our server.
This can be done automatically using instance functions of the afd.nn.Engine class provided for updating.
The process to do this is typically as follows:
An example of doing this is as follows:
int needUpdate = afd.nn.Engine.checkForUpdate();
if (needUpdate == 1) {
int startedDownload = afd.nn.Engine.downloadUpdate();
if (startedDownload == 1) {
while (afd.nn.Engine.isDownloadComplete() == 0) {
// wait for download to complete – can carry on with other
tasks
}
int updateApplied = afd.nn.Engine.applyUpdate();
}
Clears the search properties ready to start a new search public void clear();
This function takes no parameters and returns no value.
Starts a lookup or search and returns the first record
Prior to calling this function, call Clear and set the appropriate search parameters to specify the fields you wish to search for (e.g. setSearchLookup).
public int addressGetFirst(int flags)
flags is an integer and specifies options for the search. These are as follows:
The function returns one of the following values:
If AFD_SUCCESS is returned you can then call any of the properties to obtain the fields for the returned record, e.g. getAddressList. If AFD_SUCCESS or AFD_RECORD_BREAK is returned you should call addressGetNext to retrieve each subsequent record until AFD_END_OF_SEARCH is returned.
Continues a lookup or search, returning the next matching record
public int addressGetNext()
This function takes no parameters.
The function returns one of the following values:
If AFD_SUCCESS is returned you can then call any of the properties to obtain the fields for the returned record, e.g. getAddressList.
If AFD_SUCCESS or AFD_RECORD_BREAK is returned you should continue to call AddressGetNext to retrieve each subsequent record until AFD_END_OF_SEARCH is returned.
Returns data for the record key supplied
public int jumpToRecord(String recordKey)
The recordKey parameter is the key of the record to be retrieved. This would have been returned by using the getRecordKey method following a previous call to AddressGetFirst or AddressGetNext. Note this key should not be stored as it is not maintained across data updates; it is designed for reretrievinga record following a list being provided to the user.
The function returns one of the following values:
If AFD_SUCCESS is returned, any of the properties can then be called to obtain the fields for the returned record, e.g. getStreet.
Used to retrieve text to display a friendly error message to go with an error code returned from the search or validation functions (return value less than zero).
public String errorText(int errorCode)
errorCode is an int and should be set to the return value from a previous function call.
On return a description for the error is returned which can be stored or displayed for the user.
Used to save a license file on the device from a Base64 encoded string representation.
public int saveLicense(string base64License)
Base64License is the string containing the base64 encoded license data.
Returns:
Used to check if an update to the Names & Numbers data files is available.
public int checkForUpdate()
Returns:
Used to start downloading a data update.
public int downloadUpdate()
Returns:
When the function returns data continues to download in the background so your application can continue running. Poll with IsDownloadComplete periodically to determine when the download has finished.
Used to indicate when a data download has completed downloading public int isDownloadComplete()
Returns:
Used to update data files following a successful download and loads the new dataset.
public int applyUpdate()
Returns:
Note that you mustn’t call the Names & Numbers functions while this call is completing as old data will be unloaded, the new data unpacked and then loaded during this call. Hence this call does block the thread it is called on which is assumed to be the one you carry out Names & Numbers calls on.
Getter and setter methods are provided for the Names & Numbers fields.
These are as follows:
| Field Name | Description |
|---|---|
| Searchable Only Fields (no get method) | |
| SearchLookup | Specify fast-find string to look for, e.g. a postcode or street, town. No other search fields should be set when this is used. |
| Miles | Set distance in miles to search around (for radial searches) |
| Km | Set distance in kilometres to search around |
| Result Only Fields (no set method) | |
| AddressList | Returns a formatted line for list insertion containing elements of the Address record. Useful when displaying a list of results for the user to choose from. |
| RecordKey | Returns a record key to use for subsequent retrieval of the record with AddressRetrieve. Note this should not be stored as it does not persist across data updates. |
| Name | Returns a formatted Name with title, e.g. “Mr John J Smith” |
| Formatted Address Fields | |
| Postcode | Returns the Postcode |
| PostcodeFrom | Returns the original postcode if the postcode searched for has been changed (re-coded). |
| Organisation | Returns the Organisation Name |
| Property | Returns the Building Name |
| Street | Returns the House Number and Street Name |
| Locality | Returns the Locality Name |
| Town | Returns the Post Town for this address |
| Raw Address Fields (unformatted with house number in a separate field) | |
| PAFSubBuilding | The sub building name |
| PAFBuilding | The building name |
| PAFNumber | Property number |
| PAFStreet | The street name |
| PAFLocality | The locality name |
| County Fields | |
| CountyPostal | Postal County (held, or formally held by Royal Mail) |
| CountyTraditional | Traditional County Name |
| CountyAdministrative | Administrative County Name |
| Additional Postal Fields | |
| DPS | Postal County (held by Royal Mail) |
| PostcodeType | L for Large User Postcode, S for Small User. |
| MailsortCode | Used for obtaining bulk mail discounts. |
| UDPRN | Royal Mail Unique Delivery Point Reference Number assigned to this letter box. |
| JustBuilt | AFDJustBuilt – Contains the date of inclusion on PAF for properties thought to be recently built. The date is stored numerically in descending format in the form YYYYMMDD. YYYY is the year, MM is the month and DD is the day. For example 20080304 is 04/03/2008. |
| Name Fields | |
| Gender | The gender (M or F) of the resident if known. |
| Forename | The first name of the resident |
| MiddleInitial | The middle initiate of the resident. |
| Surname | The surname/last name of the resident. |
| OnEditedRoll | Indicates if the resident is on the edited electoral roll (i.e. they have not opted out). Set to Y if the are on the Edited Roll, N if not, blank for Organisation and other records). To search set to #Y to return only records on the electoral roll, #N only for those not on the electoral roll or !N for all records including Organisations but excluding those not on the Edited Roll. |
| DateOfBirth | The residents date of birth if known (electoral roll attainers in the last 10 years only). |
| Residency | Gives time in years that the occupant has lived at this address. |
| HouseholdComposition | Describes the household composition of the selected address[4] |
| **Additional Organisation | Information Fields** |
| Business | Provides a description of the type of business |
| SICCode | Standard Industry Classification Code for an organisation record. |
| Size | Gives an indication of the number of employees of an organisation. [5] |
| Phone Number Related Fields | |
| Phone | Phone Number |
| Geographical Fields | |
| GridE | Grid Easting as a 6 digit reference |
| GridN | Grid Northing as a 6/7 digit reference |
| Latitude | Latitude representation of Grid Reference in Decimal Format (WGS84) |
| Longitude | Longitude representation of Grid Reference in Decimal Format (WGS84) |
| UrbanRuralCode | Provides a code which indicates if an area is mainly urban or rural and how sparsely populated those area’s are. [3] |
| UrbanRuralName | Provides a description which goes along with the UrbanRuralCode. [3] |
| Administrative Fields | |
| WardCode | Code identifying the electoral ward for this postcode |
| WardName | Name identifying the electoral ward for this postcode |
| AuthorityCode | Local/Unitary Authority for this Postcode (same as the start of the ward code). |
| AuthorityName | Local / Unitary Authority for this postcode |
| ConstituencyCode | Code for the Parliamentary Constituency for this postcode |
| ConstituencyName | Name of the Parliamentary Constituency for this postcode |
| EERCode | Code identifying the European Electoral Region for this postcode |
| EERName | Name identifying the European Electoral Region for this postcode |
| LEACode | Code identifying the Local Education Authority for this postcode |
| LEAName | Name identifying the Local Education Authority for this postcode |
| TVRegion | ISBA TV Region (not TV Company) |
| Postcode Level Property Indicator Fields | |
| Occupancy | Indication of the type of occupants of properties found on the selected postcode [1] |
| AddressType | Indication of the type of property level data to capture to have the full address for a property on the selected postcode. [2] |
| NHS Fields | NHSCode National Health Service Area Code |
| NHSName | National Health Service Area Name |
| NHSRegionCode | National Health Service Region Code |
| NHSRegionName | National Health Service Region Name |
| PCTCode | National Health Service Primary Care Trust Code for England (Local Health Board Code in Wales, Community Health Partnership in Scotland) |
| PCTName | Name matching the PCT Code field |
| Censation Fields | |
| CensationCode | Censation Code assigned to this Postcode |
| Affluence | Affluence description |
| LifeStage | LifeStage description |
| AdditionalCensusInfo | Additional information derived from the Census. |
[1] Possible Occupancy values and descriptions are as follows (information in brackets not part of the description):
[2] Possible Address Type values and descriptions are as follows (information in brackets not part of the description):
[3] The Urban Rural Code differs from England and Wales, Scotland and Northern Ireland. The possible codes and there meanings are as follows:
England & Wales
Scotland
Northern Ireland
[4] The household composition field includes both a number and description and can have any of the following values.
[5] The Size property can have any of the following values:
(If blank, then this is unknown or not applicable).
The AFD BankFinder for Android API is easy to use and quick to implement in any Objective C application, while balancing that with providing full flexibility.
A JAR file (afdbank.jar) alongside our native library (libafdbank.so) provides access to BankFinder functionality once added to your project.
For rapid development and for a quick start, take a look at our sample program here to see how BankFinder is integrated. When you run that on Android you will need to copy your licence file to your chosen data folder on the device (unless using evaluation data). The data files (bacs.afd and bacsi.afd) will also need to be present either along with your application or on external storage. If file transfer is more difficult, you can simplify this by transfering the licence file using the SaveLicense method and obtain the latest data files automatically using the update functionality.
To integrate BankFinder into your own Project simply add the afdbank.jar file to your project libs folder and the libafdbank.so to libs\armeabi. Then create an instance of the afd.bf.Engine class to access AFD BankFinder functionality.
On creating an instance of the afd.bf.Engine class you should pass the path to access the product data files from, for example for application private storage:
Engine bfEngine = new afd.bf.Engine(getFilesDir());
Or for an example of an external path:
Engine bfEngine = new afd.bf.Engine(“/mnt/sdcard/bfdata/”);
For non-evaluation purposes we recommend using the automatic update functionality to obtain the latest data files and using the saveLicense method to save the licence from a Base64 encoded string.
A sample application demonstrating AFD BankFinder functionality is provided with the SDK.
To use this load the project in Eclipse and then click Run and follow any prompts to start the application on your device.
The path to the data folder is set in the top of the common.java and is displayed on the FastFind screen of the sample application. You may need to change this to point to an appropriate location for your target device.
For Evaluation data, copy that data to a folder on the device, or include it in your apk and ensure you have set the data path correctly as above.
For Full data, either transfer the afdbank.lic licence file to the device or use the saveLicense method to generate the file from a Base64 string that AFD will have supplied. Then use the checkForUpdates function to obtain the latest data.
The bankGetFirst and bankGetNext methods allow bank records to quickly be located.
This is typically done as follows:
See the appropriate function and property references for full details of these methods and properties.
An example lookup is as follows:
// Create an instance of the afd.bf.Engine class
Engine bfEngine = new afd.bf.Engine();
// Set the search criteria
bfEngine.clear();
bfEngine.setSearchLookup("560035");
// Do the lookup
int retVal = bfEngine.bankGetFirst(bfEngine.AFD_ALL_RECORDS);
// Deal with any error
if (retVal < 0) {
AlertDialog.Builder dlgAlert = new AlertDialog.Builder(this);
dlgAlert.setTitle("Error");
dlgAlert.setMessage(bfEngine.errorText(retVal));
dlgAlert.create().show();
return;
}
// Retrieve the results
while (retVal >= 0) {
if (retVal != bfEngine.AFD_RECORD_BREAK) {
String listItem = bfEngine.getListItem();
// do something with this data
}
retVal = bfEngine.addressGetNext();
}
The jumpToRecord method enables records to be quickly retrieved again (from a list displayed to the user, for example) using its record key. This is typically done as follows:
See the appropriate function and property references for full details of this method and properties.
An example retrieve is as follows, where recordKey is the result of calling getRecordKey for the record you originally retrieved:
// Create an instance of the afd.nn.Engine class
Engine bfEngine = new afd.bf.Engine();
// Do the lookup
int retVal = bfEngine.jumpToRecord(recordKey);
// Deal with any error
if (retVal < 0) {
AlertDialog.Builder dlgAlert = new AlertDialog.Builder(this);
dlgAlert.setTitle("Error");
dlgAlert.setMessage(bfEngine.errorText(retVal));
dlgAlert.create().show();
return;
}
// Retrieve the result
String bankName = bfEngine.getBankOwnerBankFullName();
String branchTitle = bfEngine.getBankFullBranchTitle();
String sortCode = bfEngine.getBankSortCode();
// do something with this data
The ValidateAccount method enables bank account details to be validated.
This is typically done as follows:
See the ValidateAccount reference for full details of this method.
An example account validation is as follows:
// Create an instance of the afd.bf.Engine class
Engine bfEngine = new afd.bf.Engine();
// define variables to pass to the validateAccount function
int flags = 0;
String sortCode= "774814";
String accountNo = "24782346";
String typeOfAccountCode = "";
String rollNumber = "";
String needRollNumber = "";
String iban = "";
String countryName = "";
// Do the validation
int retVal = bfEngine.validateAccount(flags, sortCode, accountNo,
typeOfAccountCode, rollNumber, needRollNumber, iban, countryName);
/* Display the result – note that the sortcode and account number may
have been updated if account translation was necessary (e.g. a nonstandard
length account number was supplied) */
if (retVal >= 0) {
AlertDialog.Builder dlgAlert = new AlertDialog.Builder(this);
dlgAlert.setTitle("Account Details Validated");
dlgAlert.setMessage("Account Number Valid");
dlgAlert.create().show();
}
else {
AlertDialog.Builder dlgAlert = new AlertDialog.Builder(this);
dlgAlert.setTitle("Error");
dlgAlert.setMessage(bfEngine.errorText(retVal));
dlgAlert.create().show();
return;
}
The validateCard method enables card numbers to be validated.
This is typically done as follows:
See the validateCard reference for full details of this method.
An example card validation is as follows:
// Create an instance of the afd.bf.Engine class
Engine bfEngine = new afd.bf.Engine();
// define variables to pass to the validateAccount function
int revisionID = 2; // for future proofing
String cardNumber="4903005748392742";
String expiryDate = "";
// Do the validation
int retVal = bfEngine.validateCard(revisionID, cardNumber,
expiryDate);
/* Display the result */
if (retVal >= 0) {
AlertDialog.Builder dlgAlert = new AlertDialog.Builder(this);
dlgAlert.setTitle("Card Details Validated");
dlgAlert.setMessage(bfEngine.cardType(retVal));
dlgAlert.create().show();
}
else {
AlertDialog.Builder dlgAlert = new AlertDialog.Builder(this);
dlgAlert.setTitle("Error");
dlgAlert.setMessage(bfEngine.errorText(retVal));
dlgAlert.create().show();
return;
}
To use full data with AFD BankFinder, a License will need to be purchased from AFD. This is provided in two forms, a file afdbank.lic and a Base64 encoded version to make entry or transfer easier.
Either save the afdbank.lic file in your data folder, or use the saveLicense method to pass the supplied base64 encoded text string to apply the license.
The process to do this is typically as follows:
An example of doing this is as follows:
int applied = bfEngine.saveLicense(licenseString);
if (applied == 1) {
// success
}
else {
// license string not valid
}
To update BankFinder data, the data files (bacs.afd and bacsi.afd) need to be replaced in your data folder with the latest versions available from our server.
This can be done automatically using instance functions of the afd.bf.Engine class provided for updating.
The process to do this is typically as follows:
An example of doing this is as follows:
int needUpdate = afd.bf.Engine.checkForUpdate();
if (needUpdate == 1) {
int startedDownload = afd.bf.Engine.downloadUpdate();
if (startedDownload == 1) {
while (afd.bf.Engine.isDownloadComplete() == 0) {
// wait for download to complete – can carry on with other
tasks
}
int updateApplied = afd.bf.Engine.applyUpdate();
}
Clears the search properties ready to start a new search public void clear();
This function takes no parameters and returns no value.
Starts a lookup or search and returns the first record Prior to calling this function, call Clear and set the appropriate search parameters to specify the fields you wish to search for (e.g. setSearchLookup).
public int bankGetFirst(int flags)
flags is an integer and specifies which clearing systems to use. The possible options are:
The function returns one of the following values:
If AFD_SUCCESS is returned you can then call any of the properties to obtain the fields for the returned record, e.g. getBankSortCode.
If AFD_SUCCESS or AFD_RECORD_BREAK is returned you should call bankGetNext to retrieve each subsequent record until AFD_END_OF_SEARCH is returned.
Continues a lookup or search, returning the next matching record
public int addressGetNext()
This function takes no parameters.
The function returns one of the following values:
If AFD_SUCCESS is returned you can then call any of the properties to obtain the fields for the returned record, e.g. getBankSortCode.
If AFD_SUCCESS or AFD_RECORD_BREAK is returned you should continue to call bankGetNext to retrieve each subsequent record until AFD_END_OF_SEARCH is returned.
Returns data for the record key supplied
public int jumpToRecord(int recordKey)
The recordNumber parameter is the key of the record to be retrieved. This would have been returned by using the getRecordKey method following a previous call to BankGetFirst or BankGetNext. Note this key should not be stored as it is not maintained across data updates; it is designed for reretrieving a record following a list being provided to the user.
The function returns one of the following values:
If AFD_SUCCESS is returned, any of the properties can be called to obtain the fields for the returned record, e.g. getBankSortCode.
Used to validate a sortcode and account number (or IBAN) to check it passes validation.
public int validateAccount(int flags, String sortCode, String accountNo, String rollNumber, String iban);
Parameters should be initialised to a blank string as appropriate if unused.
flags is an integer and specifies which clearing systems to use. The possible options are:
On return this value will be one of the following which can be useful when validating through both systems:
sortCode is a string used to specify the sort code to be validated.
accountNumber is a string used to specify the account number to be validated. It should be specified along with the sort code.
rollNumber is a string which is used to specify the Roll Number for validation. This is required along with the sortcode and account number for credits made to some building society accounts.
iban is a string which can be used in-place of passing a sortcode and accountnumber to validate an International Bank Account Number.
If the function returns a positive value (>=0) this should be taken to be valid.
Some non-standard account numbers may be transcribed to provide a standard length account number for BACS processing. It is therefore recommended that onward processing is done using the returned sortcode (getValidateSortCode) and account number (getValidateAccountNo), and type of account code returned (getValidateTypeOfAccountCode) rather than those supplied to the function.
There are also additional functions to get an IBAN from a validated sortcode and account number etc. The full list is given in section 6 of this manual.
The function returns one of the following values:
Used to validate a card number to check it passes validation.
public int validateCard(int revisionID, String cardNumber, String expiryDate);
revisionID is an integer and should be set to 2. It is provided for future proofing.
cardNumber is a string used to specify the card number you wish to validate.
expiryDate is a string used to specify the expiry date you wish to validate. This is optional but if specified a check will be made that the card is in date. This should be in the format MM/YY.
On return a positive value indicates the card is valid. The return value will indicate the type of card as follows:
A negative return value indicates an error has occurred and could be any of the following:
Used to retrieve text to display a friendly error message to go with an error code returned from the search or validation functions (return value less than zero).
public String errorText(int errorCode)
errorCode is an integer and should be set to the return value from a previous function call.
On return a description for the error is returned which can be stored or displayed for the user.
Used to retrieve text to display or store the card type returned from the ValidateCard function.
public String cardText(int cardType)
cardType is an integer and should be set to the return value from the validateCard function when that function returns a positive value.
On return a description for the card is returned, e.g. Mastercard or Visa Debit.
Used to save a license file on the device from a Base64 encoded string representation.
public int saveLicense(string base64License)
Base64License is the string containing the base64 encoded license data.
Returns:
Returns:
Used to start downloading a data update.
public int downloadUpdate()
Returns:
When the function returns data continues to download in the background so your application can continue running. Poll with IsDownloadComplete periodically to determine when the download has finished.
Used to indicate when a data download has completed downloading
public int isDownloadComplete()
Returns:
Used to update data files following a successful download and loads the new dataset.
public int applyUpdate()
Returns:
Note that you mustn’t call the BankFinder functions while this call is completing as old data will be unloaded, the new data unpacked and then loaded during this call.
Getter and setter methods are provided for the BankFinder fields. These are as follows:
| Field Name | Description | |
|---|---|---|
| Search Fields (Any of these can be set prior to a call to bankGetFirst) | ||
| setSearchLookup | Specify sort code, postcode and fast-find lookup strings here for lookup operations. No other search fields should be set when this is used. | |
| setSearchSortCode | Bank’s Sortcode | |
| setSearchBankBIC | Bank’s BIC Code | |
| setSearchBranchBIC | Branch BIC Code (should be used in conjunction with Bank BIC) | |
| setSearchPostcode | Royal Mail Postcode for correspondence for the bank | |
| setSearchBranchName | Branch Name | |
| setSearchBankName | Owner Bank Name | |
| setSearchTown | Town or Location of the bank | |
| setSearchPhone | Phone Number | |
| SearchText | Specify text to search for within any of the BankFinder fields | |
| General Bank Fields | ||
| getRecordKey | Returns a record key (integer) to use for subsequent retrieval of the record with JumpToRecord. Note this should not be stored as it does not persist across data updates. | |
| getBankSortCode | Bank’s Sortcode | |
| getBankBIC | Bank BIC Code [1] | |
| getBranchBIC | Branch BIC Code [1] | |
| getBankSubBranchSuffix | Allows a branch to be uniquely identified where there is a cluster of branches sharing the same Sort Code [1] | |
| getBankShortBranchTitle | The official title of the branch | |
| getBankCentralBankCountryCode | The ISO Country code for beneficiary banks in other countries | |
| getBankSupervisoryBody | Indicates the supervisory body for an institution that is an agency in any of the clearings. [2] | |
| getBankDeletedDate | Specifies the date the branch was closed if it is not active | |
| getBankBranchTypeIndicator | The branch type – Main Branch, Sub or NAB Branch, Linked Branch | |
| getBankMainBranchSortCode | Set for linked branches in a cluster. It identifies the main branch for the cluster. For IPSO records this is set to the branch that would handle transactions for this sortcode when the branch has been amalgamated with another. | |
| getBankMajorLocationName | Where present helps indicate the physical location of the branch. | |
| getBankMinorLocationName | Where present helps indicate the physical location of the branch. | |
| getBankBranchName | Defines the actual name or place of the branch | |
| getBankBranchName2 | An alternative name or place for the branch where applicable. | |
| getBankFullBranchTitle | Extended title for the institution | |
| getBankOwnerBankShortName | Short version of the name of the Owning Bank | |
| getBankOwnerBankFullName | Full version of the name of the Owning Bank | |
| getBankOwnerBankCode | The four digit bank code of the Owning Bank [1] | |
| getBankProperty | Bank Postal Address: Property (Building) | |
| getBankStreet | Bank Postal Address: Street | |
| getBankLocality | Bank Postal Address: Locality | |
| getBankTown | Bank Postal Address: Town | |
| getBankCounty | Bank Postal Address: County (Optional) | |
| getBankPostcode | The Royal Mail Postcode for this address | |
| getBankSTDCode | STD Code for the Bank Phone number | |
| getBankPhone | Phone number | |
| getBankFaxSTDCode | STD Code for the Bank Fax Number | |
| getBankFax | Fax number (where held) | |
| getBankCountryIndicator | Returns ‘U’ if the record is on the BACS system, or ‘I’ if the record is on IPSO. | |
| getBankSTDCode2 | STD Code for a secondary Bank Phone number | |
| getBankPhone2 | Secondary Phone number (where held) | |
| getBankList | Returns a formatted line for list insertion containing elements of the Bank record. Useful when displaying a list of branch results for the user to choose from. | |
| BACS Related Fields (Not applicable to IPSO Records) | ||
| getBACSStatus | Indicates the BACS Clearing Status [4] | |
| getBACSLastChange | Date on which BACS data was last amended | |
| getBACSClosedClearing | Indicates the date the branch is closed in BACS clearing if applicable. | |
| getBACSRedirectedFromFlag | Set to R if other branches are redirected to this sort code. | |
| getBACSRedirectedToSortCode | This specifies the sort code to which BACS should redirect payments addressed to this sort code if applicable. | |
| getBACSSettlementBankCode | BACS Bank Code of the bank that will settle payments for this branch. | |
| getBACSSettlementBankShortName | Short form name of the settlement bank | |
| getBACSSettlementBankFullName | Full form name of the settlement bank | |
| getBACSSettlementBankSection | Numeric data required for BACS to perform its settlement. | |
| getBACSSettlementBankSubSection | Numeric data required for BACS to perform its settlement. | |
| getBACSHandlingBankCode | BACS Bank Code of the member that will take BACS output from this branch. | |
| getBACSHandlingBankShortName | Short form name of the handling bank | |
| getBACSHandlingBankFullName | Full form name of the handling bank | |
| getBACSHandlingBankStream | Numeric code defining the stream of output within the Handling Bank that will be used or payments to this branch. | |
| getBACSAccountNumbered | Set to 1 if bank has transferrable account numbers | |
| getBACSDDIVoucher | Set to 1 if Paper Vouchers have to be printed for Direct Debit Instructions. | |
| getBACSDirectDebits | Set to 1 if branch accepts Direct Debits | |
| getBACSBankGiroCredits | Set to 1 if branch accepts Bank Giro Credits | |
| getBACSBuildingSocietyCredits | Set to 1 if branch accepts Building Society Credits. | |
| getBACSDividendInterestPayments | Set to 1 if branch accepts Dividend Interest Payments. | |
| getBACSDirectDebitInstructions | Set to 1 if branch accepts Direct Debit Instructions. | |
| getBACSUnpaidChequeClaims | Set to 1 if branch accepts Unpaid Cheque Claims. | |
| CHAPS Related Fields (Not applicable to IPSO Records) | ||
| getCHAPSPStatus | Indicates the CHAPS Sterling clearing Status [5] | |
| getCHAPSPStatusDescription | Provides a description for the status [5] | |
| getCHAPSPLastChange | Date on which CHAPS Sterling data was last amended | |
| getCHAPSPClosedClearing | Indicates the date the branch is closed in CHAPS Sterling clearing if applicable. | |
| getCHAPSPSettlementBankCode | CHAPS ID of the bank that will settle payments for this branch, | |
| getCHAPSPSettlementBankShortName | Short form of the name of the settlement bank | |
| getCHAPSPSettlementBankFullName | Full form of the name of the settlement bank | |
| C&CCC Related Fields (Not applicable to IPSO Records) | ||
| getCCCCStatus | Indicates the C&CCC clearing Status [6] | |
| getCCCCLastChange | Date on which C&CCC data was last amended | |
| getCCCCClosedClearing | Indicates the date the branch is closed in C&CCC clearing if applicable. | |
| getCCCCSettlementBankCode | BACS generated code of the bank that will settle payments for this branch. | |
| getCCCCSettlement | BankShortName Short form of the name of the settlement bank | |
| getCCCCSettlement | BankFullName Full form of the name of the settlement bank | |
| getCCCCDebitAgencySortCode | When the Status field is set to ‘D’ this specifies where cheque clearing is handled for this branch. | |
| getCCCCReturnIndicator | Set if this is the branch that other banks should return paper to. It will only be set for a sort code of a Member. | |
| getCCCCGBNIIndicator | Set if this is the branch that other banks should return paper to. It will only be set for a sort code of a Member. | |
| FPS Related Fields (Not applicable to IPSO Records) | ||
| getFPSStatus | Indicates the FPS clearing Status [7] | |
| getFPSLastChange | Date on which FPS data was last amended | |
| getFPSClosedClearing | Indicates the date the branch is closed in FPS clearing if applicable. | |
| getFPSRedirectedFromFlag | Set to R if other branches are redirected to this sort code. | |
| getFPSRedirectedToSortCode | This specifies the sort code to which FPS should redirect payments addressed to this sort code if applicable. | |
| getFPSSettlementBankConnection | Two digit connectivity code (will be 01 FPS Member) | |
| getFPSSettlementBankCode | Bank Code of the bank that will settle payments for this branch. | |
| getFPSSettlementBankShortName | Short form name of the settlement bank | |
| getFPSSettlementBankFullName | Full form name of the settlement bank | |
| getFPSHandlingBankConnection | Two digit connectivity code | |
| getFPSHandlingBankCode | Bank Code of the bank that will handle payments for this branch. | |
| getFPSHandlingBankShortName | Short form name of the handling bank | |
| getFPSHandlingBankFullName | Full form name of the handling bank | |
| getFPSAccountNumberedFlag | Set to 1 if bank has transferrable account numbers | |
| getFPSAgencyType | If getFPSStatus is ‘A’ this will be set to either ‘D’ for a direct agency or ‘I’ for an indirect agency. | |
| Account Validation Fields (Only applicable following a call to ValidateAccount) | ||
| getValidateSortCode | Contains the validated sortcode, may be updated if account number translation is required, e.g. for non-standard length account numbers. | |
| getValidateAccountNo | Contains the validated account number, like the sortcode may have been updated and this value is one that should be submitted to BACS. | |
| getValidateTypeOfAccountCode | This returns the value required for the type of account code field on BACS. This is normally zero but is required in some cases when account numbers are translated from nonstandard lengths. | |
| getValidateNeedRollNumber | Indicates if a roll number is required for the sortcode and account number specified. This will be one of the following values: -1 – No Roll Number required, but one was supplied 0 – No Roll Number required 1 – Roll Number required, but not supplied 2 – Roll Number required and one was supplied | |
| getValidateIBAN | If a sortcode and account number is validated this field will return the corresponding IBAN were possible. | |
| getValidateCountry | Returns the country name corresponding to an IBAN passed for validation. |
Notes:
[1] Does not apply to records in the IPSO (Irish Payment Services Organisation) clearing system.
[2] The supervisory body code can be any of the following:
[3] The clearing system property can have one of the following values
Note, that you should only accept account numbers validated on the Irish system if you can clear through both the Irish (IPSO) system as well as the UK (BACS) system.
[4] Possible values for the BACS Status fields are as follows:
[5] Possible values for the CHAPS Sterling Status fields are as follows:
[6] Possible values for the C&CCC Status fields are as follows:
Not Part of the C&CCC Clearing
[7] Possible values for the FPS Status fields are as follows:
We serve thousands of organisations and a network of hundreds of partners across multiple industry sectors, enabling them to have full confidence in their contact data.