Parameters for Options - Spectrum_OnDemand - Latest

Spectrum OnDemand Web Services (REST)

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

The following table lists the configuration options for ReverseGeocodeAllCountries.

Table 1. ReverseGeocodeAllCountries Option

Parameter

Description

Option.USA_OutputDataLabel

 

Option.USA_FindNearestUnranged

Specifies whether ReverseGeocodeUSLocation can match to a street segment that does not have a number range. This option is active when 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.INT_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:

• 12 meters—Australia (AUS), Austria (AUT), Germany (DEU)

• 7 meters—For other supported countries, the default offset is 7 meters.

Option.USA_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.USA_OffsetDescription

Specifies the offset distance from the street segments, in feet. The range is 0 to 5280. 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.

Option.INT_OffsetUnits

Specifies the unit of measurement for the street offset and corner offset options.

One of the following:

• Ft

• Mi

• M

• Km

The default is m.

Option.INT_MaxCandidates

If you select this option, specify the maximum number of candidates to return using the MaxCandidates option (see below).

Y
Yes, return candidates when multiple candidates are found. Default.
N
No, do not return candidates. Addresses that result in multiple candidates will fail to geocode.

Option.USA_OutputVerbose

Specifies whether to provide an additional description field as output. These fields provide the text equivalent to a field represented by a code. For example, LocationCode returns a code that indicates the accuracy (quality) of the assigned geocode. LocationCode.Description provides the description for the code returned.

Y
Include verbose fields.
N
Do not include verbose fields. Default.

Option.USA_OptionsTitle

 

Option.USA_OutputFormatLabel

 

Option.Fallback

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.
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.

Option.USA_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.USA_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 FindNearestIntersection option to geocode to both addresses and intersections.

Option.INT_INT_KeepMultimatch

Indicates whether to return multiple address for those input addresses that have more than one possible match.

Y
Yes, return multiple matches.
N
No, do not return multiple matches (default).

Option.USA_OutputRecordType

Specifies the optional data to include in the output. The data you select here is returned with the default output data.

  • CCensus
  • EParsed Elements
  • LLatitude/Longitude
  • RRange
  • SSegment
  • QQualifiers

If you do not want all of the fields in a record type returned, do not use Option.OutputRecordType; instead, use Option.OutputFields to specify the desired individual output fields.

Option.INT_DatabaseSearchOrder

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 an 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.

Option.USA_SearchDistanceDescription

The search distance is the distance of the radius in which to search for a match to the input coordinates. This value can be specified in either feet or meters.

Option.USA_OutputCasing

Specifies the casing of the output data. One of the following:

M
Returns the output in mixed case. Default. For example:

123 Main St

Mytown FL 12345

U
Returns the output in upper case. For example:

123 MAIN ST

MYTOWN FL 12345

Option.USA_ComponentTitle

 

Option.USA_SqueezeDescription

Specifies the distance, in feet, to move the street segment end points toward the middle of the segment. Squeeze is used in street-level matching. Use the squeeze setting to prevent address points from residing in an intersection or too close to the end of a street.

Option.USA_RetrieveAPN

Specifies whether ReverseGeocodeUSLocation should determine the address's APN (assessor's parcel number). The APN is an ID number assigned to a property by the local property tax authority. The APN is returned in the APN output field, which is part of the Census output group.

Note: This option requires that you have licensed and installed the Enhanced Points or Premium Points database. APN data is not available for all addresses. See the coverage map included with the points database.
Y
Return APN data.
N
Do not return APN data. Default.

Option.USA_LatLonFormat

Specifies the format of the latitude/longitude returned by the geocoder.

Decimal
The latitude/longitude is returned in decimal format. Default. For example: 90.000000-180.000000
Integer
The latitude/longitude is returned in integer format. For example: 90000000-180000000

Option.USA_SearchDistance

When the PBKey Fallback option is enabled, this field sets the distance to use when searching for the nearest address record with an associated PreciselyID. The allowable range is 0-5280 feet. Default = 150 feet.
Note: Supported only in forward geocoding.

Option.INT_DatabasePreference

Specifies which geocoding databases to use. One of the following:

PreferCustom

Use both standard databases and custom databases, but give preference to candidates from custom databases. Use this option if you feel your custom database is superior to the standard database.

PreferStandard

Use both standard databases and custom databases, but give preference to candidates from standard databases.

CustomOnly
Use only custom databases. Ignore standard databases
StandardOnly
Use only standard databases. Ignore custom databases.
Both

Use both standard databases and custom databases. In cases where candidates are returned from both, the standard database is preferred. Default.

Option.INT_CoordinateSystem

The coordinate system used to determine the latitude and longitude coordinates. A coordinate system specifies a map projection, coordinate units, etc. An example is EPSG:4326. EPSG stands for European Petroleum Survey Group.

Option.USA_Dataset

The name of the database resource that contains the data to use in the search process. Use the database name specified in Management Console's Spectrum Databases page.

Option.USA_OutputFields

Specifies the individual output fields you want returned. List fields with a pipe ( | ) between each field. You can use this option instead of the Option.OutputRecordType option to limit the output to those fields that are important to your data needs.

By default, these are the address fields returned: AddressLine1|LastLine|Longitude|Latitude|MatchCode|LocationCode

Option.INT_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.INT_SearchDistance

When the PBKey Fallback option is enabled, this field sets the distance to use when searching for the nearest address record with an associated PreciselyID. The allowable range is 0-5280 feet. Default = 150 feet.
Note: Supported only in forward geocoding.

Option.USA_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.INT_SearchDistanceUnits

Specifies the unit of measurement.

Values can be one of the following:

• Ft

• Mi

• M

• Km