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

Default Output Fields

The geocoder always returns fields that contain the latitude/longitude, standardized address, and result indicators. Result indicators describe how well the geocoder matched the input address to a known address and assigned a location. Result indicators also describe the overall status of a match attempt.

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

The first line of the address. For example:


                  1 Global View
Troy, NY 12180-8371

AddressLine2

104

The second line of the address. For example:

4200 Parliament Pl
STE 600
Lanham, MD 20706-1882

City

29

The municipality name.

Confidence

4

Indicates the confidence in the output provided, from 0 to 100. The higher the score, the higher the probability that the match is correct. If the match is exact, the confidence score is 100. For all other matches, the confidence score is calculated based on which portions of the input address had to be changed to obtain a match. Specifically, the confidence score is calculated by subtracting values from 100 as follows:

  • If the state is changed to obtain a match:
    • Added the state -3.75
    • No state -7.5
  • If the city is changed to obtain a match:
    • Added city -2.5
    • No city -5.0
  • If the house number is changed to obtain a match:
    • Added house number -3.75
    • No house number -7.5
  • If the street name is changed to obtain a match:
    • Added street name -3.75
    • No street name -7.5
  • If the trailing directional is changed to obtain a match:
    • Added trailing directional -1.25
    • No trailing directional -2.5
  • If the leading directional is changed to obtain a match:
    • Added leading directional -1.25
    • No leading directional -2.5
  • If the street suffix is changed to obtain a match:
    • Added street suffix -1.25
    • No street suffix -2.5
  • If the postal code is changed to obtain a match: -11.25

If you have enabled the option to return centroids, the confidence value indicates the type of centroid returned..

  • 60 for a street centroid
  • 50 for a postal code centroid
  • 35 for a city centroid
  • 30 for a county centroid
  • 25 for a state centroid
    Note: The confidence value may differ based on the Match codes and Location codes. Please refer to Match Codes for more details.
Country

25

The name of the country. This field always contains United States of America.

FirmName

41

The name of the business if the address is a business address.

LastLine

61

The complete last address line (city, state, and postal code).

Latitude

11

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

LocationCode

5

A value indicating the accuracy (quality) of the assigned geocode.

For more information, see Address Location Codes.

Longitude

12

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

MatchCode

5

Indicates the portions of the address that matched to the geocoding 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. The PreciselyID is used as a lookup key to a GeoEnrichment dataset, in order to return attribute data for the match.

PostalCode

10

Nine-digit ZIP Code with or without a hyphen.

PostalCode.AddOn

5

Four-digit ZIP Code extension.

PostalCode.Base

6

Five-digit ZIP Code.

ProcessedBy

4

The underlying software that processed the request. EnterpriseGeocoding for GeocodeUSAddress.

StateProvince

3

Two-character state abbreviation.

Status

2

Reports the success or failure of the match attempt

null
Success
F
Failure

Status.Code

23

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

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

Status.Description

128

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

StreetDataType

20

The data set used to geocode the address.

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

StreetSide

2

Indicates the side of the street the address range occupies. One of the following:

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

USUrbanName

31

Urbanization name. Used for addresses in Puerto Rico.