Digimap CAF API
Address Class
NamespacesCAF.API2Address
A data structure returned by various calls in the Service API used to represent a version of an official CAF address
Declaration Syntax
public class Address
Members
IconMemberDescription
Active
Indicates whether a CAF address is 'active'

BuildingName
The name of the building

Business
The name of the business occupying the property

CAFID
The CAF ID uniquely references a specific version of an address.

DeliveryPointID
The delivery point ID is a unique reference number for a CAF address

Island
The island which the property is located in.

Lat
The GPS latitude of the delivery point, if known.

Locality
The general locality which this property is situated in

LocationOnStreet
The number of the property within the terrace or street.

Lon
The GPS longitude of the delivery point, if known.

NameOfTerrace
The name of the terrace in which this building sits.

ParentRoadName
The name of the public road from which the property is accessed, in the event that the RoadName is a private road.

Parish
The name of the parish which this property is officially situated in

POBox
The PO Box line of the property, e.g. the string 'PO Box 4'

PostCode
The post code of the property

RoadName
The name of the road (possibly a private road such as a clos) which this property is officially accessed from.

SubElementDesc
An address line indicating the property 'sub element' which this address represents, e.g. 'Flat 1', 'The Wing'

Timestamp
A timestamp for this version of the address

USRN
The Unique Street Reference Number for the road section from which the property is addressed.

X
The easting of the property in local grid co-ordinates, if known.

Y
The northing of the property in local grid co-ordinates, if known.

Remarks

The text fields of the Address object can be concatenated together with appropriate separators in the following order to form an address:

  • Business
  • POBox
  • SubElementDesc
  • BuildingName
  • LocationOnStreet
  • NameOfTerrace
  • RoadName
  • ParentRoadName
  • Locality
  • Parish
  • Island
  • PostCode

Assembly: CAF (Module: CAF) Version: 1.0.0.0 (1.0.0.0)