Field-Level Result Indicators - Spectrum_OnDemand - main

Spectrum OnDemand Web Services (REST)

Product type
Software
Portfolio
Verify
Product family
Product
Spectrum OnDemand
Version
main
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (REST)
First publish date
2006

Field-level result indicators describe how ValidateMailingAddressPremium 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.

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

ApartmentLabel2.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 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 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.

ApartmentNumber2.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 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 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 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 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.

PostalCode.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.

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™.

RRHC.Result

C
Corrected. Canadian addresses only.
D
Dropped. The field provided on input was removed. U.S. addresses only. For more information, see 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 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.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 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 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.

StreetNamePreferredAlias.Result

Indicates the result of preferred alias processing.
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.

StreetNameAbbreviatedAlias.Result

Indicates the result of abbreviated alias processing.
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.

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 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.
StateProvince.ISO The ISO 3166-2 code of the state or province.