Field-Level Result Indicators
Field-level result indicators describe how ValidateAddressLoqate 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 OutputFieldLevelReturnCodes=Y.
The following list provides the supported fields for Spectrum. The field-level result indicators are displayed based on the applied input. If a specific field does not apply to an address, the result indicator may be blank. For the list and the description of field-level result indicators, see Description of Field-Level Result Indicators
- City.Result
- State.Result
- StateProvince.Result
- PostalCode.Result
- HouseNumber.Result
- LeadingDirectional.Result
- Street.Result
- StreetAlias.Result
- StreetName.Result
- StreetSuffix.Result
- Principality.Result
- SubStreet.Result
- County.Result
- TrailingDirectional.Result
- Subcity.Result
- ApartmentLabel.Result
- ApartmentNumber.Result
- ApartmentLabel2.Result
- POBox.Result
- RRHC.Result
- AbbreviatedAlias.Result
- PreferredAlias.Result
- Country.Result
- FirmName.Result
The table given below describes field-level result indicators.
| Spectrum Field Result Code | Field Status | Description of Status Code |
|---|---|---|
| X | fsNotApplicable | Field is not applicable to return field status. |
| V | fsVerifiedNoChange | Field has been verified using relevant reference data, no changes were needed. |
| S | fsVerifiedAliasChange | Field has been verified using relevant reference data, an alias was changed during parsing (see fsIdentifiedAlias). |
| Y | fsVerifiedSmallChange | Field has been verified using relevant reference data, a small spelling was changed. |
| C | fsVerifiedLargeChange | Field has been verified using relevant reference data, a large spelling was changed. |
| A | fsAdded | Field has been added using relevant reference data. |
| Z | fsIdentifiedNoChange | Field has been identified using relevant lexicon data, no changes were needed. Such as an input value of "PO Box 1234" may be identifiable as a PostBox, but if it is unable to be verified then a status of fsIdentifiedNoChange will be returned. |
| F | fsIdentifiedAlias | Field has been identified using relevant lexicon data, an alias was changed. Such as an input value of "Avenue" may be identifiable as an alias to the StreetType "Ave". |
| P | fsIdentifiedContext | Field has been identified using relevant context rules. Such as an input Address of "123 sdovnsdv San Bruno CA USA" may identify the word "sdovnsdv" as a Street, but only because of the context in which it appears (after an identifiable HouseNumber, and before an identifiable City). |
| R | fsEmpty | Field is empty. |
| U | fsUnrecognized | Field was unrecognized. |