The name of one or more database resources to use in the search process. Use the database name specified in the Management Console. You can specify multiple database resources. If you specify more than one database, list them in order of preference. The order of the databases has an effect when there are close match candidates from different databases. The close matches that are returned come from the database that is first in the search list. Close matches from lower ranked databases are demoted to non-close matches. You can also use the order of the databases to perform fallback processing if you have both an address point database and a street-level database installed for the country. List the address point database first and the street database second. If the address cannot be geocoded to the address point level, the geocoder will attempt to geocode it to the street level.
|
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.MaxRanges |
Maximum ranges per candidate to be returned. Default value is 0. |
|
Option.OffsetFromStreet |
Indicates the offset distance from the street segments to use in street-level geocoding. The distance is specified in the units you specify in the OffsetUnits option. The default value varies by country. For most countries, the default is 7 meters. The offset distance is used in street-level geocoding to prevent the geocode from being in the middle of a street. It compensates for the fact that street-level geocoding returns a latitude and longitude point in the center of the street where the address is located. Since the building represented by an address is not on the street itself, you do not want the geocode for an address to be a point on the street. Instead, you want the geocode to represent the location of the building which sits next to the street. For example, an offset of 40 feet means that the geocode will represent a point 40 feet back from the center of the street. The distance is calculated perpendicular to the portion of the street segment for the address. Offset is also used to prevent addresses across the street from each other from being given the same point. The diagram below shows an offset point in relation to the original point. |
|
Option.AUS.IncludeInputs |
AUS returns parsed address. Returned the standard street type abbreviation instead of the spelled out type.
Default Value is N (No). Note: This is applicable to AUS-Premium stage only.
|
|
Option.MatchModeUS |
Determines the leniency used to find a match. One of these:
|
|
Option.OffsetUnits |
Specifies the unit of measurement for the street offset and corner offset options. One of these:
Legal Values: ft = Feet, mi = Miles, m = Meters, km = Kilometers Default Value is m (Meters). |
|
Option.OffsetFromCorner |
Specifies the distance to offset the street end points in street-level matching. The distance is specified in the units you specify in the OffsetUnits option.This value is used to prevent addresses at street corners from being given the same geocode as the intersection. Note: Offset is not supported for the United Kingdom (GBR) or Japan (JPN).
The default value varies by country:
Default value is 7. |
|
Option.DatabasePreference |
Specifies which geocoding databases to use. One of these:
Legal Values: StandardOnly = Use Standard Databases Only Default Value: StandardOnly = Use Standard Databases Only |
|
Option.MaxCandidates |
Maximum number of candidates returned for a Request. Default Value is 1. |
|
Option.IncludeInputs |
Return parsed address. Returned the standard street type abbreviation instead of the spelled out type. Legal Values: Y = Yes, N = No Default Value is N. |
|
Option.CoordinateSystem |
The coordinate system is used to determine the latitude and longitude coordinates. A coordinate system specifies the detsils such as a map projection, coordinate units. An example is EPSG:4326. EPSG stands for European Petroleum Survey Group. |
|
Option.MaxRangeUnits |
Maximum number of range units that is returned for each range. Default Value is 0. |
|
Option.GeocodeLevel |
Specifies how precisely you want to geocode addresses. One of these:
|
|
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).
|
|
Option.MatchMode |
Default Value: RelaxedMode (Relaxed Mode) |
|
Option.OutputCasing |
Specifies the casing of the output data.
|
|
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 these:
|
|
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.ReturnRanges |
Specifies whether to return address range information. If you enable this option, the output field Ranges will be included in the output. A range is a series of addresses along a street segment. For example, 5400-5499 Main St. is an address range representing addresses in the 5400 block of Main St. A range may represent just odd or even addresses within a segment, or both odd and even addresses. A range may also represent a single building with multiple units, such as an apartment building.
Default Value is N. |