Kernel APIs: POSTALB^XIPUTIL

POSTALB^XIPUTIL(): Active ZIP Codes

Reference Type: Supported, Category: Address Hygiene, Integration Agreement: 3618

Description

This API returns all of the active ZIP Codes for a single ZIP Code.

Format

  POSTALB^XIPUTIL(pcode,.xip)

Input Parameters

pcode:

(required) Postal Code for which the data is being requested.

Output Parameters

.xip(n):

The number of primary subscripts in an array:

XIP(n,"CITY")—City that the USPS assigned to this PCODE. An asterisk "*" indicates which city is PREFERRED (DEFAULT).
XIP(n"CITY KEY")—USPS's assigned city key.
XIP(n,"CITY ABBREVIATION")—USPS's assigned abbreviation.
XIP(n,"COUNTY")—County associated with this PCODE.
XIP(n,"COUNTY POINTER")—Pointer to the county in File #5.13.
XIP(n,"FIPS CODE")—5-digit FIPS code associated with the county.
XIP(n,"POSTAL CODE")—Value used to look up postal data.
XIP(n,"PREFERRED CITY KEY")—USPS's preferred (DEFAULT) city key.
XIP(n,"STATE")—State associated with this PCODE.
XIP(n,"STATE POINTER")—Pointer to the state in File #5.
XIP(n,"UNIQUE KEY")—Unique lookup value.

XIP("ERROR")—Errors encountered during lookup.

Example

>S ZCODE=26452

>S ZTMP=""

D POSTALB^XIPUTIL(ZCODE,.ZTMP)

>ZW ZTMP,ZCODE
ZCODE=26452
ZTMP=2
ZTMP(1,"CITY")=WESTON*
ZTMP(1,"CITY ABBREVIATION")=
ZTMP(1,"CITY KEY")=X29362
ZTMP(1,"COUNTY")=LEWIS
ZTMP(1,"COUNTY POINTER")=335
ZTMP(1,"FIPS CODE")=54041
ZTMP(1,"POSTAL CODE")=26452
ZTMP(1,"PREFERRED CITY KEY")=X29362
ZTMP(1,"STATE")=WEST VIRGINIA
ZTMP(1,"STATE POINTER")=54
ZTMP(1,"UNIQUE KEY")=26452X29362
ZTMP(2,"CITY")=VALLEY CHAPEL
ZTMP(2,"CITY ABBREVIATION")=
ZTMP(2,"CITY KEY")=X2A444
ZTMP(2,"COUNTY")=LEWIS
ZTMP(2,"COUNTY POINTER")=335
ZTMP(2,"FIPS CODE")=54041
ZTMP(2,"POSTAL CODE")=26452
ZTMP(2,"PREFERRED CITY KEY")=X29362
ZTMP(2,"STATE")=WEST VIRGINIA
ZTMP(2,"STATE POINTER")=54
ZTMP(2,"UNIQUE KEY")=26452X2A444

VA (Internet) / VA (Intranet) / OI / HSD&D / Site Map / Terms of Use / VA Privacy Policy / Accessibility

Reviewed/Updated: December 14, 2005

If you have questions, need more information, or are having accessibility problems with this website, please contact us by E-Mail: Webmasters, Phone: 510-768-6800, or FAX: 510-768-6850.