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

The qualifiers output record type contains qualification information about the match, such as the location code and the match code. To include latitude/longitude output fields in the output, set Option.OutputRecordType = Q.

Response Element Max. Field Length with null terminator Description

CountryLevel

2

The category of postal data available. Always returns A in ReverseGeocodeUSLocation—Validates, corrects, and provides missing postal code, city name, state/county name, street address elements, and country name.

DatabaseVersion

15

USPS publish date, in the format Month Year.

EWSMatch

2

Indicates if ReverseGeocodeUSLocation denied a match because of Early Warning System (EWS) data.

Y
EWS denied a match.
null
EWS did not deny a match.

For more information about EWS, see Early Warning System (EWS).

ExpirationDate

11

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

GeoStanMatchScore

13

Record matching score (for multimatches only).

Intersection

2

Indicates if ReverseGeocodeUSLocation found a cross-street match.

T
True, a cross-street match was found.
F
False, a cross-street match was not found.

IsAlias

4

ReverseGeocodeUSLocation located a matched record by an index alias. Returns 3 characters. The first is an N for normal street match or A for alias match (including buildings, aliases and firms). The next 2 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 (when using the Usw.gsi or Use.gsi file)
06
Spatial data street name alias (when using, the Us_pw.gsi, Us_pe.gsi, Us_psw.gsi, or Us_pse.gsi file is required)
07
Alternate index (when using the Zip9.gsu, Zip9e.gsu, and Zip9w.gsu files)
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)

LACSAddress

2

Indicates if ReverseGeocodeUSLocation converted an address due to the Locatable Address Conversion System (LACS).

L
Converted
null
Not converted.

For more information about LACS, see Locatable Address Conversion System (LACS).

LocationCode.Description

128

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

MatchCode.Description

128

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

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 obtain a match.

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 first used to attempt a match.