Address fields in tLoqateAddressRow
Some countries have more complex addressing structures than others. As such, the use of individual fields in this component will vary based on the input country and the available reference data.
The table below lists all input and output fields in tLoqateAddressRow. The field that can be used on input is designated as [in] , [out] designates a field that may be present on output, and [in,out] designates that a field can be used for both input and output.
|
Field name |
Description |
|---|---|
|
Address [in,out] |
used to specify the full mailing address in the relevant country. |
|
Address1, Address2, ... Address12 [in,out] |
used to specify input data for the address line in the relevant country, split into individual address lines. |
|
DeliveryAddress [out] |
used to specify the full address including line breaks without the Organization, Locality, AdministrativeArea and PostalCode fields. |
|
DeliveryAddress1, DeliveryAddress2...DeliveryAddress12 [out] |
used to specify the individual lines contained within the DeliveryAddress field. |
|
Country [in] |
used to provide the country name or code. |
|
CountryName [out] |
used to provide the ISO 3166 official country name. |
|
ISO3166-2 [out] |
used to provide the ISO 3166 2-character country code. |
|
ISO3166-3 [out] |
used to provide the ISO 3166 3-character country code. |
|
ISO3166-N [out] |
used to provide the ISO 3166 3-digit numeric country code. |
|
SuperAdministrativeArea [in,out] |
used to provide the largest geographic data element within a country. |
|
AdministrativeArea [in,out] |
used to provide the most common geographic data element within a country. For instance, USA State, and Canadian Province. |
|
SubAdministrativeArea [in,out] |
used to provide the smallest geographic data element within a country. For instance, USA County. |
|
Locality [in,out] |
used to provide the most common population center data element within a country. For instance, USA City, Canadian Municipality. |
|
DependentLocality [in,out] |
used to provide a smaller population center data element, dependent on the contents of the Locality field. For instance, Turkish Neighborhood. |
|
DoubleDependentLocality [in,out] |
used to provide the smallest population center data element, dependent on both the contents of the Locality and DependentLocality fields. For instance, UK Village |
|
Thoroughfare [in,out] |
used to provide the most common street or block data element within a country. For instance, USA Street. |
|
DependentThoroughfare [in,out] |
used to provide the dependent street or block data element within a country. For instance, UK Dependent Street. |
|
Building [in,out] |
used to provide the descriptive name identifying an individual location, if such a name exists. |
|
Premise [in,out] |
used to provide the alphanumeric code identifying an individual location, if such a code exists. |
|
SubBuilding [in,out] |
used to provide the secondary identifiers for a particular delivery point. For instance, "FLAT 1" or "SUITE 212". |
|
PostalCode [in,out] |
used to provide the complete postal code for a particular delivery point, if such detail can be determined. |
|
PostalCodePrimary [out] |
used to provide the primary postal code used for a particular country. For instance, USA Zip, Canadian Postcode, Indian PINcode. |
|
PostalCodeSecondary [out] |
used to provide secondary postal code information, if used in a particular country and if such detail can be determined and reference data is available. For instance, USA Zip Plus 4. |
|
Organization [in,out] |
used to provide the business name associated with a particular delivery point, if such a name exists. |
|
PostBox [out] |
used to provide the post box for a particular delivery point, if it exists. |
|
Unmatched [out] |
used to list any words that could not be matched to a particular address component. |
|
Latitude [out] |
used to provide the WGS 84 latitude in decimal degrees format. |
|
Longitude [out] |
used to provide the WGS 84 longitude in decimal degrees format. |
|
GeoAccuracy [out] |
used to provide the GeoAccuracy code. For further information, see GeoAccuracy Code. |
|
GeoDistance [out] |
used to provide the radius of accuracy in meters, giving an indication of the likely maximum distance between the given geocode and the physical location. |