Response - Spectrum_OnDemand - Latest

Spectrum OnDemand Web Services (REST)

Product type
Software
Portfolio
Verify
Product family
Spectrum
Product
Spectrum OnDemand
Version
Latest
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (REST)
Copyright
2024
First publish date
2006
Last updated
2024-11-25
Published on
2024-11-25T19:42:51.884318

Response Element

Description

AddressLine1

If the address was validated, the first line of the validated and standardized address. If the address could not be validated, the first line of the input address without any changes.

AddressLine2

If the address was validated, the second line of the validated and standardized address. If the address could not be validated, the second line of the input address without any changes.

City

The validated city name.

Coastal.AdjacentName

The name of the body of water into which this body of water flows.

Coastal.Dataset

The name of the geographic database used to find nearby water boundaries.

Coastal.Distance

The distance from the address to the body of water. The distance is in miles unless you specified a different value in the Option.DistanceUnits parameter.

Coastal.FIPS_Cnty

The five-character Census Bureau FIPS code that identifies the county where the body of water is located.

Coastal.Name

The name of the body of water.

Coastal.Source

The name of the organization that provided the geographical data that defines the water boundary.

Coastal.State_Abbr

The abbreviation of the state where the body of water is located.

Coastal.Type

A description of the type of body of water. One of the following:

0
The type is unknown
1
Oceans or sea
2
Lake
7
Other
99
Intermittent. An intermittent body of water only exists during wet parts of the year.

Coastal.Vintage

The date of the geographical database used to identify nearby water boundaries.

Confidence

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

Latitude

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

LastLine

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

LocationCode

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

For more information, see Address Location Codes.

LocationCode.Description

A text description of the value in the LocationCode field.

Longitude

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

MatchCode

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

For more information, see Match Codes.

MatchCode.Description

A text description of the value in the MatchCode field.

PostalCode

The validated ZIP Codeā„¢ or postal code.

StateProvince

The validated state/province or its abbreviated value.

Status

The result of the request. One of the following:

null
Success. The request was successfully processed.
F
The request failed. See the Status.Code field for additional information.

Status.Code

The reason for the failure, if there is one.

Status.Description

A description of the code in the Status.Code field.

USFIPSStateCountyCode

The five-digit FIPS code for the state and county in which the address is located.