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

Field-level result indicators describe how ValidateAddress handled each address element. Field-level result indicators are returned in the qualifier "Result". For example, the field-level result indicator for HouseNumber is contained in HouseNumber.Result.

To enable field-level result indicators, specify Option.OutputFieldLevelReturnCodes=Y. For more information, see Output Data Options.

The following table lists the field-level result indicators. If a particular field does not apply to an address, the result indicator may be blank.

Table 1. Field-Level Result Indicators

Response Element

Description

AddressRecord.Result

These result codes apply to international addresses only.

M
Multiple. The input address matched multiple records in the postal database, and each matching record has a different value in this field.
S
Standardized. This option includes any standard abbreviations.
U
Unmatched.
V
Validated. The data was confirmed correct and remained unchanged from input.

ApartmentLabel.Result

A
Appended. The field was added to a blank input field. U.S. and Canadian addresses only.
C
Corrected. U.S. and Canadian addresses only.
D
Dropped. The field provided on input was removed. U.S. and Canadian addresses only. For more information, see About Additional Input Data.
F
Formatted. The spacing and/or punctuation was changed to conform to postal standards. Does not apply to U.S. or Canadian addresses.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output. U.S. and Canadian addresses only.
R
The apartment label is required but is missing from the input address. U.S. addresses only.
S
Standardized. This option includes any standard abbreviations.
U
Unmatched. Does not apply to Canadian addresses.
V
Validated. The data was confirmed correct and remained unchanged from input.

ApartmentNumber.Result

A
Appended. The field was added to a blank input field. U.S. and Canadian addresses only.
C
Corrected. Canadian addresses only.
D
Dropped. The field provided on input was removed. U.S. addresses only. For more information, see About Additional Input Data.
F
Formatted. The spacing and/or punctuation was changed to conform to postal standards. Does not apply to U.S. or Canadian addresses.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output. U.S. addresses that are an EWS match will have a value of P. U.S. and Canadian addresses only.
R
The apartment number is required but is missing from the input address. U.S. addresses only.
S
Standardized. This option includes any standard abbreviations. Does not apply to U.S. addresses.
U
Unmatched.
V
Validated. The data was confirmed correct and remained unchanged from input.

City.Result

A
Appended. The field was added to a blank input field. U.S. and Canadian addresses only.
C
Corrected. U.S. and Canadian addresses only.
F
Hyphens missing or punctuation errors. Canadian addresses only.
M
Multiple. The input address matched multiple records in the postal database, and each matching record has a different value in this field. Does not apply to U.S. or Canadian addresses.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output.
R
The city is required but is missing from the input address. U.S. addresses only.
S
Standardized. This option includes any standard abbreviations. Does not apply to U.S. addresses.
U
Unmatched. Does not apply to Canadian addresses.
V
Validated. The data was confirmed correct and remained unchanged from input.

Country.Result

These result codes do not apply to U.S. or Canadian addresses.

M
Multiple. The input address matched multiple records in the postal database, and each matching record has a different value in this field.
S
Standardized. This option includes any standard abbreviations.
U
Unmatched.
V
Validated. The data was confirmed correct and remained unchanged from input.

FirmName.Result

C
Corrected. U.S. addresses only.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output. U.S. and Canadian addresses only.
U
Unmatched. U.S. and Canadian addresses only.
V
Validated. The data was confirmed correct and remained unchanged from input. U.S. addresses only.

HouseNumber.Result

A
Appended. The field was added to a blank input field. Canadian addresses only.
C
Corrected. Canadian addresses only.
D
Dropped. The field provided on input was removed. U.S. addresses only. For more information, see About Additional Input Data.
F
Formatted. The spacing and/or punctuation was changed to conform to postal standards. Does not apply to U.S. or Canadian addresses.
O
Out of range. Does not apply to U.S. or Canadian addresses.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output. Canadian addresses only.
R
The house number is required but is missing from the input address. Canadian addresses only.
S
Standardized. This option includes any standard abbreviations. Does not apply to U.S. or Canadian addresses.
U
Unmatched.
V
Validated. The data was confirmed correct and remained unchanged from input.

LeadingDirectional.Result

A
Appended. The field was added to a blank input field. U.S. and Canadian addresses only.
C
Corrected. Non-blank input was corrected to a non-blank value. U.S. addresses only.
D
Dropped. The field provided on input was removed. U.S. addresses only. For more information, see About Additional Input Data.
F
Formatted. The spacing and/or punctuation was changed to conform to postal standards. Does not apply to U.S. or Canadian addresses.
M
Multiple. The input address matched multiple records in the postal database, and each matching record has a different value in this field. U.S. addresses only.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output. Canadian addresses only.
S
Standardized. This option includes any standard abbreviations.
U
Unmatched.
V
Validated. The data was confirmed correct and remained unchanged from input. Does not apply to Canadian addresses.

POBox.Result

A
Appended. The field was added to a blank input field. Canadian addresses only.
C
Corrected. Canadian addresses only.
D
Dropped. The field provided on input was removed. U.S. addresses only. For more information, see About Additional Input Data.
F
Formatted. The spacing and/or punctuation was changed to conform to postal standards. Does not apply to U.S. or Canadian addresses.
M
Multiple matches. The input address matched multiple records in the postal database, and each matching record has a different value in this field. U.S. addresses only.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output. Canadian addresses only.
R
The P.O. Box number is required but is missing from the input address. U.S. addresses only.
S
Standardized. This option includes any standard abbreviations.
U
Unmatched.
V
Validated. The data was confirmed correct and remained unchanged from input.
Blank
Not applicable.

PostalCode.Result

A
Appended. The field was added to a blank input field. U.S. and Canadian addresses only.
C
Corrected. U.S. and Canadian addresses only.
F
Formatted. The spacing and/or punctuation was changed to conform to postal standards. Does not apply to U.S. or Canadian addresses.
M
Multiple. The input address matched multiple records in the postal database, and each matching record has a different value in this field. Does not apply to Canadian addresses.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output. Does not apply to U.S. addresses.
R
The postal code is required but is missing from the input address. U.S. addresses only.
S
Standardized. This option includes any standard abbreviations. Does not apply to U.S. or Canadian addresses.
U
Unmatched. For example, if the street name does not match the postal code, both StreetName.Result and PostalCode.Result will contain U.
V
Validated. The data was confirmed correct and remained unchanged from input.

PostalCodeCity.Result

These result codes apply to international addresses only.

M
Multiple. The input address matched multiple records in the postal database, and each matching record has a different value in this field.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output.
S
Standardized. This option includes any standard abbreviations.
U
Unmatched.
V
Validated. The data was confirmed correct and remained unchanged from input.

PostalCode.Source

These result codes apply to U.S. addresses only.

FinanceNumber
The ZIP Code™ in the input was verified by using USPS® Finance Number groupings.
ZIPMOVE
The ZIP Code™ in the input address was corrected because the USPS® redrew ZIP Code™ boundaries and the address is now in a different ZIP Code™.

PostalCode.Type

P
The ZIP Code™ contains only PO Box addresses. U.S. addresses only.
U
The ZIP Code™ is a unique ZIP Code™ assigned to a specific company or location. U.S. addresses only.
M
The ZIP Code™ is for military addresses. U.S. addresses only.
null
The ZIP Code™ is a standard ZIP Code™.

RRHC.Result

C
Corrected. Canadian addresses only.
D
Dropped. The field provided on input was removed. U.S. addresses only. For more information, see About Additional Input Data.
M
Multiple matches. The input address matched multiple records in the postal database, and each matching record has a different value in this field. U.S. addresses only.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output. Canadian addresses only.
R
The rural route/highway contract is required but is missing from the input address. U.S. addresses only.
S
Standardized. This option includes any standard abbreviations. U.S. and Canadian addresses only.
U
Unmatched. U.S. and Canadian addresses only.
V
Validated. The data was confirmed correct and remained unchanged from input. U.S. and Canadian addresses only.

RRHC.Type

These result codes apply to U.S. addresses only.

HC
The address is a Highway Contract address.
RR
The address is a Rural Route address.

StateProvince.Result

A
Appended. The field was added to a blank input field. U.S. and Canadian addresses only.
C
Corrected. U.S. addresses only.
M
Multiple. The input address matched multiple records in the postal database, and each matching record has a different value in this field. Does not apply to U.S. or Canadian addresses.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output.
R
The state is required but is missing from the input address. U.S. addresses only.
S
Standardized. This option includes any standard abbreviations. Does not apply to U.S. addresses.
U
Unmatched. Does not apply to Canadian addresses.
V
Validated. The data was confirmed correct and remained unchanged from input.

Street.Result

These result codes apply to international addresses only.

M
Multiple. The input address matched multiple records in the postal database, and each matching record has a different value in this field.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output.
R
Street corrected. House number is out of range. Applies to French, UK, and Japanese records only.
S
Standardized. This option includes any standard abbreviations.
U
Unmatched.
V
Validated. The data was confirmed correct and remained unchanged from input.

StreetName.AbbreviatedAlias.Result

Indicates the result of abbreviated alias processing. One of the following:

null
No abbreviated alias processing attempted.
B
The StreetName field contains the base street name.
L
The standardized address length is less than 31 characters so the StreetName field contains the base name.
N
No abbreviated alias found.
Y
An abbreviated alias was found for input address. The StreetName field contains the abbreviated alias.

StreetName.Alias.Type

This result code applies to U.S. addresses only.

Note: In previous releases this field was named StreetName.AliasType with no "." between "Alias" and "Type." This old name is obsolete. Please update your processes to use the new name StreetName.Alias.Type.
Abbreviated
The alias is an abbreviation of the street name. For example, HARTS-NM RD is an abbreviated alias for HARTSVILLE NEW MARLBORO RD.
Changed
There has been an official street name change and the alias reflects the new name. For example if SHINGLE BROOK RD is changed to CANNING DR, then CANNING DR would be a changed alias type.
Other
The street alias is made up of other names for the street or common abbreviations of the street.
Preferred
The street alias is the locally preferred alias. For example, a street is named "South Shore Dr." because it runs along the southern shore of a lake, not because it is south of a municipal demarcation line. So, "South" is not a predirectional in this case and should not be shorted to "S". So, "South Shore Dr." would be the preferred alias.

StreetName.PreferredAlias.Result

Indicates the result of preferred alias processing. One of the following:

null
No preferred alias processing attempted.
A
Preferred alias processing was not attempted because the input address matched to an alias. Preferred alias processing is only attempted for base addresses.
N
No preferred alias found.
Y
A preferred alias was found for the input address. The StreetName field contains the preferred alias.

StreetName.Result

A
Appended. The field was added to a blank input field. Canadian addresses only.
C
Corrected. U.S. and Canadian addresses only.
D
Dropped. The field provided on input was removed. U.S. addresses only. For more information, see About Additional Input Data.
F
Formatted. The spacing and/or punctuation was changed to conform to postal standards. Does not apply to U.S. or Canadian addresses.
M
Multiple. The input address matched multiple records in the postal database, and each matching record has a different value in this field. U.S. addresses only.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output. Does not apply to U.S. addresses.
S
Standardized. This option includes any standard abbreviations. U.S. and Canadian addresses only.
U
Unmatched.
V
Validated. The data was confirmed correct and remained unchanged from input.

StreetSuffix.Result

A
Appended. The field was added to a blank input field. U.S. and Canadian addresses only.
C
Corrected. U.S. and Canadian addresses only.
D
Dropped. The field provided on input was removed. U.S. and Canadian addresses only. For more information, see About Additional Input Data.
F
Formatted. The spacing and/or punctuation was changed to conform to postal standards. Does not apply to U.S. or Canadian addresses.
M
Multiple. The input address matched multiple records in the postal database, and each matching record has a different value in this field. U.S. addresses only.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output. Canadian addresses only.
S
Standardized. This option includes any standard abbreviations.
U
Unmatched. Does not apply to U.S. addresses.
V
Validated. The data was confirmed correct and remained unchanged from input.

TrailingDirectional.Result

A
Appended. The field was added to a blank input field. U.S. and Canadian addresses only.
C
Corrected. U.S. and Canadian addresses only.
D
Dropped. The field provided on input was removed. U.S. and Canadian addresses only. For more information, see About Additional Input Data.
F
Formatted. The spacing and/or punctuation was changed to conform to postal standards. Does not apply to U.S. or Canadian addresses.
M
Multiple. The input address matched multiple records in the postal database, and each matching record has a different value in this field. U.S. addresses only.
P
Pass-through. The data was not used in the validation process, but it was preserved in the output. Canadian addresses only.
S
Standardized. This option includes any standard abbreviations.
U
Unmatched. Does not apply to Canadian addresses.
V
Validated. The data was confirmed correct and remained unchanged from input.

USUrbanName.Result

These result codes apply to U.S. addresses only.

A
Appended. The field was added to a blank input field.
C
Corrected.
M
Multiple. The input address matched multiple records in the postal database, and each matching record has a different value in this field.
U
Unmatched.
V
Validated. The data was confirmed correct and remained unchanged from input.