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 |
---|---|
|
specifies the full mailing address in the relevant country. |
|
specifies input data for the address line in the relevant country, split into individual address lines. |
|
specifies the full address including line
breaks without the |
|
specifies the individual lines contained
within the |
|
provides the country name or code. |
|
provides the ISO 3166 official country name. |
|
provides the ISO 3166 2-character country code. |
|
provides the ISO 3166 3-character country code. |
|
provides the ISO 3166 3-digit numeric country code. |
|
provides the largest geographic data element within a country. |
|
provides the most common geographic data element within a country. For example, USA State, and Canadian Province. |
|
provides the smallest geographic data element within a country. For example, USA County. |
|
provides the most common population center data element within a country. For example, USA City, Canadian Municipality. |
|
provides a smaller population center data
element, dependent on the contents of the |
|
provides the smallest population center data
element, dependent on both the contents of the |
|
provides the most common street or block data element within a country. For example, USA Street. |
|
provides the dependent street or block data element within a country. For example, UK Dependent Street. |
|
provides the descriptive name identifying an individual location, if such a name exists. |
|
provides the alphanumeric code identifying an individual location, if such a code exists. |
|
provides the secondary identifiers for a particular delivery point. For example, "FLAT 1" or "SUITE 212". |
|
provides the complete postal code for a particular delivery point, if such detail can be determined. |
|
provides the primary postal code used for a particular country. For example, USA Zip, Canadian Postcode, Indian PINcode. |
|
provides secondary postal code information, if used in a particular country and if such detail can be determined and reference data is available. For example, USA Zip Plus 4. |
|
provides the business name associated with a particular delivery point, if such a name exists. |
|
provides the post box for a particular delivery point, if it exists. |
|
lists any words that could not be matched to a particular address component. |
|
provides the WGS 84 latitude in decimal degrees format. |
|
provides the WGS 84 longitude in decimal degrees format. |
|
provides the GeoAccuracy code. For further information, see GeoAccuracy Code. |
|
provides the radius of accuracy in meters, giving an indication of the likely maximum distance between the given geocode and the physical location. |
AddressFormat [out] |
provides the
elements of the address. For example, if Address contains
805 Veterans Blvd Redwood City CA 94063-1734 , AddressFormat contains Premise Thoroughfare
Locality AdministrativeArea PostalCode . |
DeliveryAddressFormat [out] |
provides the
elements of the delivery address. For example, if Address contains
805 Veterans Blvd Redwood City CA 94063-1734 , DeliveryAddressFormat contains Premise
Thoroughfare Locality AdministrativeArea PostalCode . |
MatchRuleLabel [out] |
provides the label of the match rule used to match the input with the reference data. For further information, see the match rule syntax. |
Contact [in,out] |
provides the contact name. |
Function [in,out] |
provides the function or job title. |
Department [in,out] |
provides the organizational department. |
LocalityExtra [out] |
provides information that could be as part of the Locality
field. This information is not mandatory but is necessary to obtain a complete
delivery address. For example in a French address: 12 rue de la Gare, 75019
PARIS CEDEX, France . CEDEX will be considered as
Locality Extra. |
DependentLocalityName [in,out] |
provides the name indicator within the |
DependentLocalityType [in,out] |
provides the type indicator within the |
DoubleDependentLocalityName [in,out] |
provides the name indicator within the DoubleDependentLocality
field. For example, if DoubleDependentLocality contains Xin
Zhuang Zhen , DoubleDependentLocalityName contains
Xin Zhuang if a sufficient level of parsing detail exists for the
particular country. |
DoubleDependentLocalityType [in,out] |
provides the
type indicator within the DoubleDependentLocality field. For example, if DoubleDependentLocality contains Xin Zhuang
Zhen , DoubleDependentLocalityType contains Zhen if a sufficient level of parsing detail exists for the particular
country. |
ThoroughfarePreDirection [in,out] |
provides the prefix directional contained within the
Thoroughfare field. For example, if Thoroughfare
contains N MAIN ST , ThoroughfarePreDirection
contains N if a sufficient level of parsing detail exists for the
particular country. |
ThoroughfareLeadingType [in,out] |
provides the leading thoroughfare type indicator within the
Thoroughfare field. For example, if Thoroughfare
contains RUE DE LA GARE , ThoroughfareLeadingType
contains RUE if a sufficient level of parsing detail exists for the
particular country. |
ThoroughfareName [in,out] |
provides the name indicator within the Thoroughfare field. For
example, if Thoroughfare contains N MAIN ST ,
ThoroughfareName contains MAIN if a sufficient
level of parsing detail exists for the particular country. |
ThoroughfareTrailingType [in,out] |
provides the trailing thoroughfare type indicator within the
Thoroughfare field. For example, if Thoroughfare
contains N MAIN ST , ThoroughfareTrailingType
contains ST if a sufficient level of parsing detail exists for the
particular country. |
ThoroughfarePostDirection [in,out] |
provides the
postfix directional contained within the Thoroughfare field. For example, if Thoroughfare contains MAIN ST
N , ThoroughfarePostDirection contains N
if a sufficient level of parsing detail exists for the particular country. |
|
provides the prefix directional contained within the
DependentThoroughfare field. For example, if
DependentThoroughfare contains N MAIN ST ,
DependentThoroughfarePreDirection contains N if
a sufficient level of parsing detail exists for the particular country. |
DependentThoroughfareLeadingType [in,out] |
provides the leading thoroughfare type indicator within the
DependentThoroughfare field. For example, if
DependentThoroughfare contains RUE DE LA GARE ,
DependentThoroughfareLeadingType contains RUE if
a sufficient level of parsing detail exists for the particular country. |
DependentThoroughfareName [in,out] |
provides the
name indicator within the DependentThoroughfare field. For example, if DependentThoroughfare contains N MAIN
ST , DependentThoroughfareName contains MAIN if a sufficient level of parsing detail exists for the particular
country. |
DependentThoroughfareTrailingType [in,out] |
provides the trailing thoroughfare type indicator within the
DependentThoroughfare field. For example, if
DependentThoroughfare contains N MAIN ST ,
DependentThoroughfareTrailingType contains ST if
a sufficient level of parsing detail exists for the particular country. |
DependentThoroughfarePostDirection [in,out] |
provides the prefix directional contained within the
DependentThoroughfare field. For example, if
DependentThoroughfare contains MAIN ST N ,
DependentThoroughfarePostDirection contains N if
a sufficient level of parsing detail exists for the particular country. |
BuildingLeadingType [in,out] |
provides the leading building type indicator within the
Building field. For example, if Building
contains BLOC C , BuildingLeadingType contains
BLOC if a sufficient level of parsing detail exists for the
particular country. |
BuildingName [in,out] |
provides the name indicator within the Building field. For
example, if Building contains WESTMINSTER HOUSE ,
BuildingName contains WESTMINSTER if a
sufficient level of parsing detail exists for the particular country. |
BuildingTrailingType [in,out] |
provides the
name indicator within the Building field. For example, if Building contains WESTMINSTER
HOUSE , BuildingTrailingType contains HOUSE if a sufficient level of parsing detail exists for the particular
country. |
PremiseType [in,out] |
provides the leading premise type indicator within the Premise
field. For example, if Premise contains Plot 7/7A ,
PremiseType contains Plot if a sufficient level
of parsing detail exists within a particular country. |
PremiseNumber [in,out] |
provides the leading premise type indicator within the Premise
field. For example, if Premise contains Plot 7/7A ,
PremiseNumber contains 7/7A if a sufficient
level of parsing detail exists within a particular country. |
PremiseExtra [out] |
provides information that could be as part of the Premise
field. This information is not mandatory but is necessary to obtain a complete
delivery address. For example in a French address: 12 bis rue de la Gare,
75019 PARIS, France . Bis will be considered as Locality
Extra. |
SubBuildingType [in,out] |
provides the leading sub-building type indicator within the
SubBuilding field. For example, if SubBuilding
contains FLAT 1 , SubBuildingType contains
FLAT if a sufficient level of parsing detail exists within a
particular country. |
SubBuildingLeadingType [in,out] |
provides the leading sub-building type indicator within the
SubBuilding field. For example, if SubBuilding
contains FLAT 1 , SubBuildingLeadingType contains
FLAT if a sufficient level of parsing detail exists within a
particular country. |
SubBuildingNumber [in,out] |
provides the leading sub-building type indicator within the
SubBuilding field. For example, if SubBuilding
contains FLAT 1 , SubBuildingNumber contains
1 if a sufficient level of parsing detail exists within a
particular country. |
SubBuildingName [in,out] |
provides the
descriptive name within the SubBuilding field. For example:
|
OrganizationName [in,out] |
provides the trailing type indicator contained within the
Organization field. For example, if Organization
contains Loqate Inc , OrganizationName contains
Loqate if a sufficient level of parsing detail exists for the
particular country. |
OrganizationType [in,out] |
provides the trailing type indicator contained within the
Organization field. For example, if Organization
contains Loqate Inc , OrganizationType contains
Inc if a sufficient level of parsing detail exists for the
particular country. |
PostBoxType [in,out] |
provides the type indicator contained within the PostBox
field. For example, if PostBox contains PO BOX
1234 , PostBoxType contains PO BOX if a
sufficient level of parsing detail exists for the particular country. |
PostBoxNumber [in,out] |
provides the alphanumeric indicator contained within the
PostBox field. For example, if PostBox contains
PO BOX 1234 , PostBoxNumber contains
1234 if a sufficient level of parsing detail exists for the
particular country. |