Parameters for Addresses Outside the U.S.
|
Parameter |
Description |
|---|---|
|
Option.CloseMatchesOnly |
Specifies whether to return only those geocoded results that are close match candidates. For example, if there are 10 candidates and two of them are close candidates, and you enable this option, only the two close matching candidates would be returned instead of all 10. To specify what is considered a close match, use the MustMatch options. Address candidates are ranked according to how closely the input address matches these preferences.
|
|
Option.ExpandCandidates |
This option applies to U.K. addresses only. Specifies whether to return multiple close matches (one for each delivery point on the street). By default, if a street has multiple addresses/delivery points, the geocoder returns a single close match, with each individual delivery point available as a range. |
|
Option.GeocodeLevel |
Specifies how precisely you want to geocode addresses. One of the following:
|
|
Option.FallbackToGeographic |
Specifies whether to attempt to determine a geographic region centroid when an address-level geocode cannot be determined. This option is not available for the United Kingdom (GBR).
|
|
Option.FallbackToPostal |
Specifies whether to attempt to determine a postal code centroid when an address-level geocode cannot be determined. For Argentina, you must use HERE data for postal geocoding. This option is not available for Bahamas, Hong Kong, Macau, Philippines, Uruguay, and Venezuela. For Argentina, you must use HERE data for postal geocoding. The majority of African countries and Middle Eastern countries do not include postal code data, and therefore do not support postal centroid geocoding.
|
|
Option.Interpolation |
Specifies whether to perform address point interpolation. This option only works if you have a point database installed. This option is available for selected countries only. Address point interpolation uses point data to refine geocode results. By default, the geocoding process estimates the location of an address based on the street numbers at either end of street segment. For example, if a street segment runs from 100 Main St. to 200 Main St., then a request for 150 Main St. will return a location in the middle of the segment. With interpolation, the geocoder finds the position of 180 Main St. in the point data, and it is about two-thirds of the way down the street. Using this information, the geocoder can estimate the position of 150 Main St. based on 100 and 180 Main St. In this case, the geocoder estimates the location of the address slightly away from the center of the segment.
|
|
Option.KeepMultimatch |
Specifies whether to return results when the address matches to multiple candidates in the database. If this option is not selected, an address that results in multiple candidates will fail to geocode. If you select this option, specify the maximum number of candidates to return using the MaxCandidates option (see below).
|
|
MatchModeInt |
Specifies how to determine whether a candidate is a close match. One of the following:
|
|
Option.MustMatchInput |
Specifies whether candidates must match all non-blank input fields to be considered a close match. For example, if an input address contains a city and postal code, then candidates for this address must match the city and postal code to be considered a close match.
|
|
Option.MustMatchHouseNumber |
Specifies whether candidates must match the house number to be considered a close match. House number data is not available for every country. The Africa and Middle East countries do not generally have house numbers in the data source. Some countries covered in the Latin America database have house number data. See Address Guidelines for Latin America for details of Latin America house number and postal coverage. If you select this option you should also require an exact match on street name. This option does not significantly affect performance. It does, however, affect the type of match if the candidate address corresponds to a segment that does not contain any ranges. The type of match can also be affected when the house number range for a candidate does not contain the input house number. If you relax the house number, you should set the maximum ranges to be returned to a value higher than 0.
|
|
Option.MustMatchStreet |
Specifies whether candidates must match the street name to be considered a close match. This option is not used for this country. If a close match is found, the geocoder attempts expanded street name manipulation, which looks for candidates with names that sound like the input address or that are spelled improperly. This slows down performance but increases the match rate . If the geocoding database is indexed, the performance impact is reduced.
|
|
Option.MustMatchLocality |
Specifies whether candidates must match the locality (or equivalent) to be considered a close match. The meaning of Locality varies for different countries. If you do not require exact matches on locality, the geocoder searches on the street address matched to the particular postal code, and considers other localities that do not match the name, but do match the postal code. The majority of African and Middle East countries do not use locality or equivalent as part of an address. If a locality is matched it can contribute to a higher candidate ranking, but there is no penalty if locality is omitted or unmatched.
|
|
Option.MustMatchCity |
Specifies whether candidates must match the city to be considered a close match. For Japan, this field specifies whether the candidate must match the municipality subdivision (oaza). If you do not require exact matches on city, the geocoder searches on the street address matched to the particular postal code, and considers other cities that do not match the name, but do match the postal code. Specifies whether candidates must match the municipality subdivision (oaza) to be considered a close match. If you do not require exact matches on city, the geocoder searches on the street address matched to the particular postal code, and considers other cities that do not match the name, but do match the postal code.
|
|
Option.MustMatchCounty |
Specifies whether candidates must match the county (or equivalent) to be considered a close match. The meaning of county varies for different countries. The majority of countries in the Africa database (XA1) do not use a county or equivalent as part of an address. The majority of countries in the Middle East database (XM1) do not use a county or equivalent as part of an address. The majority of countries in the Latin American database (XL1) do not use a county or equivalent as part of an address.
One of the following:
|
|
Option.MustMatchStateProvince |
Specifies whether candidates must match the state or province (or equivalent) to be considered a close match. This option is not used for this country. The majority of African and Middle East countries do not use a state/province or equivalent as part of an address. If a state/province is matched it can contribute to a higher candidate ranking, but there is no penalty if state/province is omitted or unmatched.
One of the following:
|
|
Option.MustMatchPostalCode |
Specifies whether candidates must match the postal code to be considered a close match. If you do not require exact match on postal codes, the geocoder searches a wider area for a match. While this results in slower performance, the match rate is higher because the request does not need to match exactly when it compares match candidates. Specifies whether candidates must match the postal code to be considered a close match. If you do not require exact match on postal codes, the geocoder searches a wider area for a match. While this results in slower performance, the match rate is higher because the request does not need to match exactly when it compares match candidates. This field is not used in this country. For Argentina, you must use HERE data for postal geocoding. The majority of African countries and Middle Eastern countries do not include postal code data, and therefore do not support postal centroid geocoding. Some countries covered in the Latin America database have postal code data. See Address Guidelines for Latin America for details of Latin America house number and postal coverage. For India, the Postal code must match preference can be used for geographic geocoding. This can produce better geographic matched candidates. For other countries, Postal code match preference can be used with street or postal geocoding only.
|
|
Option.MustMatchPostDistrict |
Specifies whether the postal district portion of the postcode must match in order for the match to be considered a close match. UK postcodes are divided into two sections: the outward code, which is to the left of the space, and the inward code, which is to the right. The outward code represents the postal district. For example, in the postcode CB3 OHH, the postal district is CB3, which is Cambridge. |