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

Qualifier output fields contain qualification information about the match, such as the location code and the match code. To include postal data fields in the output, set Option.OutputRecordType = Q.

Response Element Max. Field Length with null terminator Description

AddressLineResolved

5

For two-line addresses, indicates which address line was used to obtain the match.

0
The address could not be matched, or the address matched to multiple addresses.
1
AddressLine1 was used to obtain the match.
2
AddressLine2 was used to obtain the match.
3
Both address lines were used in their original order.
4
Both address lines were used but the order of the lines was switched to obtain the match.
5
The input address was a one line address.

CountryLevel

2

The category of the postal data used to validate the address. Always returns "A" for U.S. addresses. Category A means that the postal data is sufficient to validate and correct addresses, including providing missing postal code, city name, state/county name, street address elements, and country name.

DatabaseVersion

 

The publish date of the USPS data used to validate the address, in the format Month Year.

EWSMatch

2

Indicates whether the address was not matched because it is in the Early Warning System (EWS) data.

Y
The address matched to an address in the EWS data so the match was denied.
null
The address did not match to an address in the EWS data.

ExpirationDate

11

Date the database expires, in the format MM/DD/YYYY.

Geocoder.MatchCode

4

Indicates how closely the input address matches the candidate address.

Note: The match codes returned in this field are different from the match codes described in Match Codes. Instead, the match codes returned in this field are taken from a set of match codes that are compatible with all other country geocoders. For more information, see Result Codes for International Geocoding.

GeoStanMatchScore

13

Record matching score (for multimatches only).

Intersection

2

Indicates if the input address matched to a cross-street.

T
True
F
False

IsAlias

4

Indicates whether the address matched an index alias in the postal data. Returns three characters. The first is an N for normal street match or A for alias match (including buildings, aliases, firms, etc.). The next two characters are:

01
Basic index (normal address match)
02
USPS street name alias index
03
USPS building index
04
USPS firm name index
05
Statewide intersection alias match
06
Spatial data street name alias
07
Alternate index
08
LACSLink
09
Auxiliary file match
11
POI index (when using poi.gsi)
12
USPS Preferred Alias
13
ZIPMove match (when using us.gsz)
14
Expanded Centroids match (when using us_cent.gsc and/or bldgcent.gsc)

IsCloseMatch

2

Indicates whether or not the address was a unique match or if there were candidate addresses.

Y
Yes, the address is a close match. This field always contains "Y" if there is only one match.
N
No, the address is not a close match. The record is a candidate.

LACSAddress

2

Indicates if the input address was converted due to the Locatable Address Conversion System (LACS).

L
Converted
null
Not converted

LocationCode.Description

LocationCode converted to text. Only returned when you set the configuration options to return additional descriptions (verbose).

MatchCode.Description

MatchCode converted to text. Only returned when you set the configuration options to return additional descriptions (verbose).

RecordType

18

Indicates the record type:

  • GeneralDelivery
  • HighRise
  • FirmRecord
  • Normal
  • PostOfficeBox
  • RRHighwayContract
  • Geographic (non USPS TIGER match)
  • Auxiliary (match to an auxiliary file)

RecordType.Default

2

Indicates type of match that occurred for the record type HighRise or RRHighwayContract:

Y
Default match
N
Exact match
U
Not matched

StreetDataCode

3

Indicates the data used to geocode the address. One of the following:

0
USPS data
1
TIGER data
2
TomTom data
6
HERE data
7
TomTom point-level data
9
Auxiliary file data
10
User Dictionary
11
HERE point-level data
12
Master Location Data

For more information about these databases, see Enterprise Geocoding Databases.

StreetDataType

20

Indicates the data initially used for the match attempt. Note that the output field StreetDataCode shows which data was actually used to obtain the match.

The data indicated in StreetDataType may be different from that in StreetDataCode if a match cannot be made in the initial match attempt. For example, if a points database is loaded, GeocodeUSAddress will first attempt a match to the point data because this is the most accurate type of match. If a point-level match cannot be made, GeocodeUSAddress will attempt to match to street data. If the match is made using street data, then the SreetDataType would indicate the point-level data and the StreetDataCode would indicate the street data.

For more information, see How GeocodeUSAddress Processes Addresses.