When a match is found for an input ZIP Code, city and state, or combination, the following information is returned to your program:
-
USPS city name.
-
USPS short city name.
-
USPS state abbreviation.
-
City type (primary, secondary, or vanity).
-
USPS finance number.
-
USPS last line number.
-
A table of up to 100 cities that are found to be within the returned ZIP Code. Each entry in the table contains the information listed above.
-
A table of up to 999 ZIP Codes that a city/state falls within. Each entry includes the information listed above including the USPS ZIP Code.
-
USPS ZIP Code.
-
Return codes indicating the results of the match attempt.
-
Audit trail information showing I/O counts.
Vanity City Names
A field has been provided in the calling interface that indicates whether vanity city names are to be allowed or not allowed. Not allowing vanity city names can prevent any city names from being returned, if the only cities for the ZIP Code are vanity cities. If the input city name is a vanity city name, and vanity city names are allowed, the output city name can be a vanity city name if one is found on the database. If vanity city names are not allowed, only primary or secondary city names are returned.