Address, Postcode and Bank solutions

Home Products News Evaluate Purchase Support Partners Contact
- Pocket Names & Numbers Manual

PROGRAMMING WITH POCKET NAMES & NUMBERS

The Application Programming Interface

Understanding UK Address Data

Overview

Future-Proofing

Data Types or Structures

Names & Numbers Address Record
Used to lookup postcodes, search for address or other additional information. It contains all data on a single person or organisation.

Type nnRecType Field Details
  RevisionID As String * 2   Revision No of Names & Numbers - set to '10'
  Postcode As String * 8   Postcode (& used as 'Postcode To' in range searches)
  PostcodeFrom As String * 8 Postcode From  (used where a range of postcodes is required & also returns the OLD postcode if a changed postcode is detected)
  DPS As String * 2   Delivery Point Suffix
  Mailsort As String * 5   Mailsort Code
  STDCode As String * 8   Predicted STD Code for Postal Sector
  WardCode As String * 6   Local Authority Ward Code
  WardName As String * 30   Local Authority Ward Name
  NHSAreaCode As String * 3   NHS Area - Code
  NHSAreaName As String * 50   NHS Area - Name
  NHSRegionCode As String * 3   NHS Region - Code
  NHSRegionName As String * 40 NHS Region - Name
  PostcodeType As String * 6   L=Large User, S=Small User, N=Non PAF
  GridE As String * 6   Grid Reference Easting
  GridN As String * 6   Grid Reference Northing
  Distance As String * 6   Linear Distance from Test Grid Ref - in 10ths of a Kilometer
  PostalCounty As String * 30   County Name according to Postal Authority
  AdministrativeCounty As String * 30  County Name for Local Authority purposes
  TraditionalCounty As String * 30   Traditional County Name
  Town As String * 30   Post Town
  Locality As String * 70   Locality (includes Double Dependant Locality)
  Street As String * 120   Street or Thoroughfare (includes Dependent Thoroughfare)
  HouseNo As String * 10   Building Number
  Building As String * 60   Building Name
  SubBuilding As String * 60   Sub-Building Name
  Phone As String * 20   Telephone No where known, incl STD Code
  Surname As String * 30   Surname
  FirstName As String * 30   First Name
  Initial2 As String * 6   Initial of Second Forename
  Residency As String * 6   Length of time resident at this address
  Gender As String * 6   M=Male; F=Female; X=Ambiguous; Blank=Not Known
  Organisation As String * 120   Organisation Name (includes Department, if any)
  Business As String * 100   Business Description - eg 'Solicitors'
  Size As String * 6 Size of company indicated by employee number bands  eg A=1-9 employees
  SIC As String * 10   Standard Industry Classification
  tvRegion As String * 30   TV Region
  Constituency As String * 50   Parliamentary Constituency
  Authority As String * 50   Local Authority / Unitary Authority
  CameoUKCategory As String * 2   UK Category
  CameoIncomeCategory As String * 2    Income Category
  CameoInvestorCategory As String * 2   Investor Category
  CameoFinancialCategory As String * 2   Financial Category
  CameoUnEmploymentCategory As String * 2   Unemployment Category
  CameoPropertyCategory As String * 2   Property Category
  OnEditedRoll As String * 6 Indicates if a record appears on the edited electoral roll (Y/N) 
  HouseholdComposition As String * 106 Household Composition Type
  dob As String * 6 Date of Birth
  CensusCode As String * 30 Censation Census Code
  Affluence As String * 30 Affluence Description
  LifeStage As String * 100 LifeStage Description
  AdditionalCensusInfo As String * 200 Additional Census Information
  Occupancy As String * 6 Indicates if postcode likely contains residential, business addresses, or both.
The following possible values are returned:
1. Large User Organisation
2. Small User Organisation
3. Mostly Organisations
4. Mixed
5. Mostly Residential
6. Residential
  AddressType As String * 6 Indicates the type of property data needed to be captured for addresses on this postcode.
The following possible values are returned:
1. Numbered
2. Numbered and Named
3. Numbered and Named, Likelihood of Multiple Occupancy
4. Named
5. Non-Standard Address Format
6. PO Box
7. No Property Information (Capture Organisation or Resident Name)
  CouncilTaxBand As String * 6 Additional Dataset: Provides the Council Tax Band that the selected residential property resides in (Bands A-H)
  PCTCode As String * 3 NHS Primary Care Trust Code in England (Local Heath Board Code in Wales).
  PCTName As String * 50 NHS Primary Care Trust Name in England (Local Heath Board Name in Wales).
  Udprn As String * 8 Royal Mail Unique Delivery Point Reference Number (where applies)
  Spare As String * 12  
  EERCode As String * 2 European Electoral Region Code
  EERName As String * 40 European Electoral Region Name
  UrbanRuralCode As String * 2 Indicates if an area is mostly urban or rural 
  UrbanRuralName As String * 60 Indicates if an area is mostly urban or rural 
  LEACode As String * 3 Local Education Authority Code
  LEAName As String * 50 Local Education Authority Name
  AFDJustBuilt As String * 20 Contains the date a building became live on PAF if it is likely to have been a new build.
  Latitude As String * 7 Provides the latitude value for the postcode.
  Longitude As String * 7 Provides the longitude value for the postcode.
  Reserved As String * 255 Reserved for future use
End Type

Please note that the Cameo fields above will return no data if the Cameo data set has not been purchased and installed by the end user, but space for them must always be allocated in the data structure even if they are not used.

Cameo Descriptions Record
Only used when the optional CAMEO data set is installed. It is used to return the descriptions corresponding to the Cameo classifications returned by the last call to the GetMatch or GetPostcode function.

Type CameoRecType Field Details
  UKCategoryGroup As String * 100   UK Category Group
  UKCategoryType As String * 100   UK Category Type
  IncomeCategoryGroup As String * 100 Income Category Group
  IncomeCategoryType As String * 100   Income Category Type
  InvestorCategoryGroup As String * 100   Investor Category Group
  InvestorCategoryType As String * 100   Investor Category Type
  FinancialCategoryGroup As String * 100   Financial Category Group
  FinancialCategoryType As String * 100   Financial Category Type
  EconomicallyInactiveHouseholds As String * 20  Economically Inactive Households
  EconomicInactivityIndex As String * 40   Economic Inactivity Index
  AverageHousePrice As String * 20   Average House Price
End Type


Changes Record
This is used by the GetChanges function - which can test a postcode to see if it has changed, and return the replacement postcode.

Type ChangesType Field Details
  Postcode As String * 8  Postcode Data
End Type

Phone Change Record
This is used by the PhoneChange2000 function - which can test a phone number to see if it has been replaced by the National Code & Number Change, and return the replacement phone number.

Type PhoneChangesType Field Details
  PhoneNo As String * 15  Phone Number Data
End Type

General String Record
This record type contains a single string of 255 characters in length, and is used by the ListFirst and ListNext functions to provide lists of possible data fields for any field search.

Type AFDStringType Field Details
  Value As String * 255  General String Data
End Type

Constants

Functions

Any Questions? Call now on 01624 811711
  Pocket Names & Numbers
      Overview
      Features
      Data Included
      Prices
      Manual
      Screen Shots
      License Agreement
      Download Free Evaluation
      Software Developer Kit
      Download Product Sheet
      Order Online
      Order by Form/Phone/Email

  Manual Contents
      Introduction & Installation
      Overview
      Find Box & Lookup
      Results List
      Transferring Addresses
      Programming with
      Pocket Names & Numbers
      Programming with .NET
      and Pocket Names & Numbers

  Appendix
      A - Standard Industry
      Classifications
      B - Grid References
      C - End User License Agreement
      D - Reregistration Request Form