Configuration Options - Spectrum_OnDemand - Latest

Spectrum OnDemand Web Services (REST)

Product type
Software
Portfolio
Verify
Product family
Spectrum
Product
Spectrum > Geocoding > Enterprise Tax
Spectrum > Web Services
Spectrum > Spatial > Spectrum Spatial
Spectrum > Spectrum Platform
Spectrum > Quality > Addressing
Spectrum > Quality > Spectrum Quality
Spectrum > Spatial > Spectrum Spatial Insights
Spectrum > Discovery
Spectrum OnDemand
Spectrum > Dataflow Designer
Spectrum > Spatial > Spectrum Spatial Analyst
Spectrum > Quality > Context Graph
Version
Latest
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (REST)
Copyright
2024
First publish date
2006
ft:lastEdition
2024-07-17
ft:lastPublication
2024-07-17T23:23:16.481321

ReverseGeocodeUSLocation Configuration Options

The following table lists the configuration options for ReverseGeocodeUSLocation.

Parameter Description

Option.Dataset

The name of the database that contains the data to use in the search process.

Option.SearchDistance

Specifies the radius, in feet, that ReverseGeocodeUSLocation searches for matches. The allowable range is 0 - 5280 feet. Default = 150 feet.

Option.FindClosestPoint

Enables matching to the nearest point address within the search radius, rather than to the closest feature - such as a street segment or intersection as well as point addresses.

Note: This option requires that at least one streets data set and one points data set are loaded; otherwise, the match will be made to the closest feature.
Y
Match to the nearest point address within the search radius.
N
Match to the closest point address or feature. Default.

Option.FindNearestAddress

Specifies whether ReverseGeocodeUSLocation should find the nearest interpolated address to the input geocode.

Y
Find the nearest address. Default.
N
Do not find the nearest address.
Note: You can use this option with the Option.FindNearestIntersection option to geocode to both addresses and intersections.

Option.FindNearestUnranged

Specifies whether ReverseGeocodeUSLocation can match to a street segment that does not have a number range. This option is active when Option.FindNearestAddress=Y.

Y
Allow ReverGeocodeUSLocation to match to an unranged street segment. Default.
N
Do not allow ReverseGeocodeUSLocation to match to an unranged street segment.
Note: If you are using the point-level data option, ReverseGeocodeUSLocation ignores the Nearest Unranged option.

Option.FindNearestIntersection

Specifies whether ReverseGeocodeUSLocation should find the nearest street intersection to the input geocode.

Y
Find the nearest street intersection. Default.
N
Do not find the nearest street intersection.
Note: You can use this option with the Option.FindNearestAddress option to geocode to both addresses and intersections.

Option.Offset

Specifies the offset distance from the street segments. The allowable range is 0 - 5280 feet. Default = 50 feet.

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.

Street coordinates are accurate to 1/10,000th of a degree and interpolated points are accurate to 1/1,000,000th of a degree.

Option.Squeeze

Specifies the distance, in feet, to squeeze the street end points in street-level geocoding. The range is 0 -2147483647 feet. Default = 50 feet. The following diagram compares the end points of a street to squeezed end points.

Option.LatLonFormat

Specifies the format to use for returned latitude/longitude.

Decimal
The format is 90.000000-180.000000. Default.
Integer
The format is 90000000-180000000.

Option.InputLatLonFormat

Specifies the format to use for input latitude/longitude.

Decimal
The format is 90.000000-180.000000.
Integer
The format is 90000000-180000000. Default.

Option.FIND_APPROXIMATE_PBKEY

When Option.FIND_APPROXIMATE_PBKEY is enabled, if an address match is not made to Master Location Data (MLD), but to a different dataset, the PreciselyID of the nearest MLD point located within the search distance is returned. To distinguish when a fallback PreciselyID is returned, the PreciselyID return value contains a leading character of "X" rather than "P", for example: X00001XSF1IF. Note, all of the other fields returned for the address match, including the geocode and all associated data, reflect the match results for the input address. The fallback PreciselyID can then be used for the lookup to the GeoEnrichment dataset(s), and the attribute data for the fallback location is returned for the match.

For more information, see PreciselyID Fallback.

Note: This option requires that you have licensed and installed the Master Location Dataset.

The search distance for the nearest MLD point is configurable using the ReverseGeocodeUSLocation Option.SearchDistance field. The allowable range is 0 - 5280 feet. Default = 150 feet.

Y
When a matched address does not have an associated PreciselyID, attempt to return the nearest address record's PreciselyID.
N
When a matched address does not have an associated PreciselyID, do not return the nearest address record's PreciselyID. Default.