Result Codes - 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

Result codes contain information about the success or failure of the geocoding attempt, as well as information about the accuracy of the geocode.

Note: As Enterprise Geocoding transitions its administrative tasks to a web-based Management Console, labels for the options may use different wording than what you see in Enterprise Designer. There is no difference in behavior.
Table 1. Result Code Output for

Response Element

Description

Geocoder.MatchCode

Indicates how closely the input address matches the candidate address. For more information, see Result Codes for International Geocoding.For more information, see Match Codes.

IsCloseMatch

Indicates whether or not the address is considered a close match. An address is considered close based on the "Close match criteria" options on the Matching tab.

Y
Yes, the address is a close match.
N
No, the address is not a close match.

MultiMatchCount

For street address geocoding, the number of matching address positions found for the specified address.

For intersection geocoding, the number of matching street intersection positions found for the specified addresses.

Status

Reports the success or failure of the match attempt

null
Success
F
Failure

Status.Code

If the geocoder could not process the address, this field will show the reason.

  • Internal System Error
  • No Geocode Found
  • Insufficient Input Data
  • Multiple Matches Found
  • Exception occurred
  • Unable to initialize Geocoder
  • No Match Found

Status.Description

If the geocoder could not process the address, this field will show a description of the failure.

Problem + explanation
Returned when Status.Code = Internal System Error.
Geocoding Failed
Returned when Status.Code = No Geocode Found.
No location returned
Returned when Status.Code = No Geocode Found.
No Candidates Returned
The geocoder could not identify any candidate matches for the address.
Multiple Candidates Returned and Keep Multiple Matches not selected
The address resulted in multiple candidates. In order for the candidate address to be returned, you must specify KeepMultimatch=Y.

LocationPrecision

A code describing the precision of the geocode. One of the following:

0
No coordinate information is available for this candidate address.
1
Interpolated street address.
2
Street segment midpoint.
3
Postal code 1 centroid.
4
Partial postal code 2 centroid.
5
Postal code 2 centroid.
6
Intersection.
7
Point of interest. This is a placeholder value. Spectrum databases do not have POI data, so it is not possible to get this return.
8
State/province centroid.
9
County centroid.
10
City centroid.
11
Locality centroid.
12 - 15 (LocationPrecision codes)
For USA, 12 indicates point ZIP precision. A point ZIP is a 5-digit ZIP Code that represents a unique ZIP such as a single site, building, or organization. For AUS, 12 indicates a single close match to a postal (PO Box) location. This can be generated from the standard Street Range database only (not the G-NAF database). For IND, 12 indicates a sub locality (block or sector) match. This is more specific than other geographic matches (city, district, or state).
For most countries, LocationPrecision codes 12 through 15 are reserved for unspecified custom items.
12
Point ZIP precision. A point ZIP is a 5-digit ZIP Code that represents a unique ZIP such as a single site, building, or organization.
12
Single close match to a postal (PO Box) location. This can be generated from the standard street range database only (not the G-NAF database).
12
Sublocality (block or sector) match. This is more specific than other geographic matches (city, district, or state).
13
Additional point precision for unspecified custom item.
14
Additional point precision for unspecified custom item.
15
Additional point precision for unspecified custom item.
16
The result is an address point.
17
The result was generated by using address point data to modify the candidates segment data.
18
The result is an address point that was projected using the centerline offset feature. You must have both a point and a street range database to use the centerline offset feature, and thereby return LocationPrecision 18.

StreetDataType

The default search order rank of the database used to geocode the address. A value of "1" indicates that the database is first in the default search order, "2" indicates that the database is second in the default search order, and so on.