Default Output - 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

ReverseGeocodeUSAddress always includes the following fields in the output.

Response Element Max. Field Length with null terminator Description

AdditionalInputData

61

This field may contain input data that was not used for matching; for example, input address information that appears after a mail stop or attention designator.

AddressLine1

104

First line of the address.

AddressLine2

104

Second line of the address.

City

29

Municipality name.

Confidence

4

Indicates the confidence in the output provided. The range is from 0 (zero) to 100, with 0 being no match and 100 being an exact match.

Country

25

The name of the country. Since ReverseAPNLookup only works for U.S. locations, this field will always contain United States of America.

Distance

8

The distance, in feet, from the input geocode to nearest matched address or intersection.

Elevation

11

The location's elevation in feet above or below sea level.

FirmName

41

Name of the company.

LastLine

61

Complete last address line (municipality, state, and postal code).

Latitude

11

7-digit number in degrees and calculated to 4 decimal places (in the format specified).

LocationCode

5

Indicate the accuracy (quality) of the assigned geocode.

For more information, see Address Location Codes.

Longitude

12

7-digit number in degrees and calculated to 4 decimal places (in the format specified).

MatchCode

5

Indicates the portions of the address that matched to the directory file.

For more information, see Match Codes.

PBKey

13

A unique address identifier that is returned when an address match is made using the Master Location Dataset. PreciselyID is used as a lookup key to a GeoEnrichment dataset, in order to return attribute data for the match.

PercentGeocode

6

The percent along the street segment that matches the geocode. For example, if the returned geocode falls 1/3 along the way of the entire street segment, the percent is 33.000.

Note: This value is always 0.0 for matches to point-level data and intersections.

PostalCode

10

9-digit ZIP Code with or without a hyphen.

PostalCode.AddOn

5

4-digit ZIP Code extension.

PostalCode.Base

6

5-digit ZIP Code.

ProcessedBy

4

The underlying software that processed the request. KGR for ReverseGeocodeUSLocation.

RRHC

2

Rural Route Highway Contract (RRHC). This field is null if the address not a RRHC.

StateProvince

3

2-character state abbreviation.

Status

2

Reports the success or failure of the match attempt.

null
Success
F
Failure

Status.Code

23

Reason for failure:

  • Internal System Error
  • No Geocode Found
  • Insufficient Input Data

Status.Description

32

Description of the problem:

Problem + explanation
Returned when Status.Code contains "Internal System Error"
Geocoding Failed
Returned when Status.Code contains "No Geocode Found"
No location returned
Returned when Status.Code contains "No Geocode Found"

StreetDataType

20

The data set that ReverseGeocodeUSLocation attempted to match against.

USPS
USPS
TIGER
TIGER
TOMTOM
TomTom Streets data set
SANBORN POINT DATA
Sanborn Points data set
HERE
HERE Streets data set
TOMTOM POINT DATA
TomTom Points data set
AUXILIARY
Auxiliary file
USER DICTIONARY
User Dictionary
HERE POINT DATA
HERE Points data set
MASTER LOCATION
Master Location Data

StreetSide

2

Indicates the side of the street the range occupies.

L
The range occupies the left side of the street.
R
The range occupies the right side of the street.
B
The range occupies both sides of the street.
U
Undetermined.

USUrbanName

31

Urbanization name. Puerto Rico addresses only.