MatchDetail Type

Indicates the details of an address candidate in the list of matches (if any).

Remarks

This type contains the results of a search made with the component after a call to the ValidateAddress method. The fields contained by this type are listed below.

Fields

Address1
String

Address line 1 of an address candidate in the list of matches (if any).

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

Address2
String

Address line 2 of an address candidate in the list of matches (if any).

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

ChangeType
String

Changes made to the Address (during validation process) compared to this address candidate. This is a comma-separated string collection. Possible returned values are

APARTMENT_NUMBER_NOT_FOUND
APARTMENT_NUMBER_REQUIRED
NORMALIZED
REMOVED_DATA
BOX_NUMBER_REQUIRED
NO_CHANGES
MODIFIED_TO_ACHIEVE_MATCH
STREET_RANGE_MATCH
BOX_NUMBER_MATCH
RR_OR_HC_MATCH
CITY_MATCH
POSTAL_CODE_MATCH
RR_OR_HC_BOX_NUMBER_NEEDED
FORMATTED_FOR_COUNTRY
APO_OR_FPO_MATCH
GENERAL_DELIVERY_MATCH
FIELD_TRUNCATED
UNABLE_TO_APPEND_NON_ADDRESS_DATA
INSUFFICIENT_DATA
HOUSE_OR_BOX_NUMBER_NOT_FOUND
POSTAL_CODE_NOT_FOUND
INVALID_COUNTRY
SERVICE_UNAVAILABLE_FOR_ADDRESS

This is only valid for FedEx.

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

City
String

City name of an address candidate in the list of matches (if any).

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

Company
String

Name of the company that resides at an address candidate in the list of matches (if any).

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

CountryCode
String

Country code of an address candidate in the list of matches (if any).

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

Quality
String

Quality factor an address candidate in the list of matches (if any).

Each address is returned with an assigned quality value that indicates how closely the address candidate matches the search criteria. This is used to rate the submitted address. If the Quality is too low, the component returns the "Address Not Validated" message.

In FedEx, possible values range from 0 to 100, with 100 being the highest and zero indicating failure.

In UPS, this is applicable for a non street-level address validation and/or classification (i.e., when the Address1 is not set in the request). Possible values are:


Value	Meaning
1.0	Exact Match - The input address matches an address in the Address Matching Systems database; under the condition where the Address Matching System is able to explicitly differentiate an address from all others in the database.
.95-.99	Very close match
.90-.94	Close match
.70-.89	Possible match
.01-.69	Poor match
0	No candidates found. The Address Matching System is not able to match the Address from any other one in the database.

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

ResidentialStatus
String

Residential status of an address candidate in the list of matches (if any). Possible returned values are:

UNDETERMINED
BUSINESS
RESIDENTIAL
INSUFFICIENT_DATA
UNAVAILABLE
UNKNOWN
NOT_APPLICABLE_TO_COUNTRY

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

State
String

State or province code of an address candidate in the list of matches (if any).

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

ZipCode
String

Postal Code of an address candidate in the list of matches (if any).

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

Constructors

public MatchDetail();