Response Description
| Response Element | Description |
|---|---|
| location.address.formattedAddress | Formatted Address is a combination of mainAddressLine and addressLastLine. |
| location.address.placeName | Name of the place of the site address |
| location.address.mainAddressLine | Main address line of the address. |
| location.address.addressLastLine | Last line part of the site address |
| location.address.areaName1 | State/Province |
| location.address.areaName2 | County/Region |
| location.address.areaName3 | City/Town |
| location.address.areaName4 | Suburb/Village |
| location.address.postCode | 5-digit ZIP Code with or without a hyphen. |
| location.address.postCodeExt | Zip code extension. |
| location.address.country | The 3-character ISO country code. |
| location.address.addressNumber | Address number of the address. |
| location.address.streetName | Street name of the address |
| location.address.unitType | Apartment/House type of the address. |
| location.address.unitValue | Apartment/House number of the address. |
| location.address.customFields | The fields and corresponding values returned are country-specific. |
| location.distance | Distance of the dwelling along the segment. Note: 'distance' is returned only when the search is performed using the 'latitude/longitude' or 'ipAddress' input. If the search is performed using the 'country' input, this element is not returned.
|
| location.distance.unit(attribute) | Unit in which the distance is measured (for e.g. feet). Based on the unit sent in request, the response is returned, for example if 'Feet' is sent in request, value in 'Feet' is returned. Note: 'distance.unit' is returned only when the search is performed using the 'latitude/longitude' or 'ipAddress' input. If the search is performed using the 'country' input, this element is not returned.
|
| location.geometry.type | Geometry Type which is “Point” in this case (Only in JSON response) |
| location.geometry.coordinates | Location Coordinates i.e. Longitude and Latitude of the Location (Only in JSON response) (WGS 84 datum/EPSG:4326 coordinate system) |
| location.geometry.point.latitude | Latitude of the location (WGS 84 datum/EPSG:4326 coordinate system) |
| location.geometry.point.longitude | Longitude of the location (WGS 84 datum/EPSG:4326 coordinate system) |
| location.totalUnitCount | Total number of units associated with this location |
| location.ranges.range.placeName | Placename of the range of location |
| location.ranges.range.unit.unitInfo | Information about particular unit inside the range of location like flat number inside an apartment |
| location.ranges.range.unit.formattedUnitAddress | Complete formatted unit address |
| location.ranges.unit.postalVerified |
YES - the postal code is valid NO - the postal code is invalid |