As mentioned in Understanding Extended Match Codes, when set to True, GS_FIND_MATCH_CODE_EXTENDED returns additional information about any changes in the house number, unit number and unit type fields in the matched address, as well as whether there was address information that was ignored. This additional information is provided in a 3rd hex digit that is appended to match codes for address-level matches only - A, G, H, J, Q, R, S, T or U (see Match codes).
"Address information ignored" is specified when any of the following conditions apply:
-
The output address has a mail stop (GS_MAIL_STOP).
-
The output address has a second address line (GS_ADDR2).
-
The input address is a dual address (two complete addresses in the input address). For example, "4750 Walnut St. P.O Box 50".
-
The input last line has extra information that is not a city, state or ZIP Code, and is ignored. For example, "Boulder, CO 80301 USA", where "USA" is ignored when matching.
The following table contains the description of the Extended Match Code 3rd hex digit return values:
Code |
In 3rd hex position means: |
---|---|
0 |
Matched on all address information on line, including Unit Number and Unit Type if included. |
1 |
Matched on Unit Number and Unit Type if included. Extra information on address line ignored. Extra information not considered for matching moved to GS_ADDR2 or GS_MAIL_STOP field. |
2 |
Matched on Unit Number. Unit Type changed. |
3 |
Matched on Unit Number. Unit Type changed. Extra information on address line ignored. Extra information not considered for matching moved to GS_ADDR2 or GS_MAIL_STOP field. |
4 |
Unit Number changed or ignored. |
5 |
Unit Number changed or ignored. Extra information on address line ignored. Extra information not considered for matching moved to GS_ADDR2 or GS_MAIL_STOP field. |
6 |
Unit Number changed or ignored. Unit Type changed or ignored. |
7 |
Unit Number changed or ignored. Unit Type changed or ignored. Extra information on address line ignored. Extra information not considered for matching moved to GS_ADDR2 or GS_MAIL_STOP field. |
8 |
Matched on Unit Number and Unit Type if included. House Number changed or ignored. |
9 |
Matched on Unit Number and Unit Type if included. House Number changed or ignored. Extra information not considered for matching moved to GS_ADDR2 or GS_MAIL_STOP field. |
A |
Matched on Unit Number. Unit Type changed. House Number changed or ignored. |
B |
Matched on Unit Number. Unit Type changed. House Number changed or ignored. Extra information on address line ignored. Extra information not considered for matching moved to GS_ADDR2or GS_MAIL_STOP field. |
C |
House Number changed or ignored. Unit Number changed or ignored. |
D |
House Number changed or ignored. Unit Number changed or ignored. Extra information on address line ignored. Extra information not considered for matching moved to GS_ADDR2 or GS_MAIL_STOP field. |
E |
House Number changed or ignored. Unit Number changed or ignored. Unit Type changed or ignored. |
F |
House Number changed or ignored. Unit Number changed or ignored. Unit Type changed or ignored. Extra information on address line ignored. Extra information not considered for matching moved to GS_ADDR2 or GS_MAIL_STOP field. |