Result Indicators - 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

Response Element

Description

AddressFormat

The type of address data being matched to the address format:

F
French format (for example: 123 Rue Main)
E
English format (for example: 123 Main St)
Confidence

Indicates the confidence in the output provided; from 0 to 100. The higher the score, the higher the confidence in the match. Calculated based on the match results for individual output fields, using the following algorithm:

Census.MatchCode + LatLong.StreetMatchCode + LatLong.MatchCode

The maximum confidence score is 100, so if this calculation results in a value greater than 100, the Confidence score is returned as 100.

The following values are used:

CouldNotValidate

If no match was found, which address component could not be validated:

  • ApartmentNumber
  • HouseNumber
  • StreetName
  • PostalCode
  • City
  • Directional
  • StreetSuffix
  • Firm
  • POBoxNumber
  • RuralRoute
Note: More than one component may be returned, in a comma-separated list.

CountryLevel

The category of address matching available. This is always "A" for U.S. and Canadian addresses. One of the following:

A
The address is in a country for which there is highly detailed postal data available. Addresses in this match level can have the following address elements validated and corrected, and added if missing from the input:
  • Postal code
  • City name
  • State/county name
  • Street address elements
  • Country name
B
The address is in a country for which there is a medium level of postal data available. Addresses in this match level can have the following address elements validated and corrected, and added if missing from the input:
  • Postal code
  • City name
  • State/county name
  • Country name
C
The address is in a country for which the postal data is least detailed. Addresses in this match level can have the following actions performed on them:
  • Validate and correct country name (cannot supply missing country name)
  • Validate the format of the postal code (cannot supply missing postal code or validate the code)

MatchScore

MatchScore provides an indication of the degree to which the output address is correct. It is significantly different from Confidence in that Confidence is indicates how much the input address changed to obtain a match, whereas the meaning of Match Score varies between U.S. and non-U.S. addresses.

For U.S. addresses, MatchScore is a one-digit score on a scale of 0 to 9 that reflects the closeness of the street-name match (after transformations by ValidateMailingAddressUSCAN, if any). Zero indicates an exact match and 9 indicates the least likely match. If no match was found, this field is blank.

For non-U.S. and non-Canadian addresses, MatchScore is a five-digit score, with a maximum value of 00999. Higher numbers indicates a closer match.

This field does not apply to Canadian addresses.

Note that you cannot equate match scores from U.S. addresses with those of non-U.S. addresses. For example, a match score of 4 for a U.S address does not indicate the same level of match as a 00004 for a non-U.S. address.

Note: The Validate Address and Advanced Matching Module components both use the MatchScore field. The MatchScore field value in the output of a dataflow is determined by the last stage to modify the value before it is sent to an output stage. If you have a dataflow that contains Validate Address and Advanced Matching Module components and you want to see the MatchScore field output for each stage, use a Transformer stage to copy the MatchScore value to another field. For example, Validate Address produces an output field called MatchScore and then a Transformer stage copies the MatchScore field from Validate Address to a field called AddressMatchScore. When the matcher stage runs it populates the MatchScore field with the value from the matcher and passes through the AddressMatchScore value from Validate Address.

MultipleMatches

Indicates which address component had multiple matches, if multiple matches were found:

  • Firm
  • LeadingDirectional
  • PostalCode
  • StreetName
  • StreetSuffix
  • TrailingDirectional
  • Urbanization
Note: More than one component may be returned, in a comma-separated list.

ProcessedBy

Which address coder processed the address:

USA
U.S. address coder
CAN
Canadian address coder
INT
International address coder

RecordType

Type of address record, as defined by U.S. and Canadian postal authorities (supported for U.S. and Canadian addresses only):

  • FirmRecord
  • GeneralDelivery
  • HighRise
  • PostOfficeBox
  • RRHighwayContract
  • Normal

RecordType.Default

Code indicating the "default" match:

Y
The address matches a default record.
null
The address does not match a default record.

Status

Reports the success or failure of the match attempt. For multiple matches, this field is "F" for all the possible matches.

null
Success
F
Failure

Status.Code

Reason for failure, if there is one. For multiple matches, all possible matches is "MultipleMatchesFound."

  • DisabledCoder
  • InsufficientInputData
  • MultipleMatchesFound
  • UnableToValidate

Status.Description

Description of the problem, if there is one.

Possible Multiple Addresses Found
This value will appear if Status.Code=MultipleMatchesFound.
Address Not Found
This value will appear if Status.Code=UnableToValidate.
PerformUSProcessing disabled
This value will appear if Status.Code=DisabledCoder.
PerformCanadianProcessing disabled
This value will appear if Status.Code=DisabledCoder.
PerformInternationalProcessing disabled
This value will appear if Status.Code=DisabledCoder.