Enums for storing and retrieving data
This chapter contains the valid enums used with GsHandleGet, GsDataSet, GsDataGet, and GsMultipleGet.
The following describes the contents of each table column.:
Enum |
Lists the defined constant used to access this element. |
GsHandleGet |
|
GsDataSet |
A bullet indicates this enum is valid when using GsDataSet. |
GsDataGet |
|
GsMultipleGet |
Indicates the valid match types.
|
Length |
A number indicating the largest string GeoStan returns for this enum. This length includes a NULL-termination character. Symbolic constants use the naming convention <<NAME>>_LENGTH. For example the enum GS_ADDRLINE returns the input or output address line. The maximum length of an address line is 61. Therefore, the symbolic constant is GS_ADDRLINE_LENGTH and is defined as 61. |
Description |
A brief explanation of the information returned. If you use an invalid enum, GeoStan returns an Invalid Argument error. |
Common enums for storing and retrieving data
|
Enum |
Lengtha |
GsHandleGet |
GsDataSet |
GsDataGet |
GsMultipleGet |
||||
|---|---|---|---|---|---|---|---|---|---|
|
|
|
Street |
Segment |
Range |
|
Input |
Output |
Centerline |
|
|
GS_ADDRLINE First address line or address line for singleline addresses. For singleline addresses, enter address line and last line combined as a single input, for example,"4750 Walnut St 80301". |
256 |
|
|
|
I |
l |
l |
|
l |
|
GS_ADDRLINE_SHORT Shortest possible address line that can be constructed from available short street name and the other address line components. |
61 |
|
|
|
|
|
l |
|
|
|
GS_ADDR2 Second address line. |
61 |
|
|
|
l |
l |
l |
|
|
|
GS_ADDRTYPE Address Type regarding number of units:
Note: This field is only available with the MLD Extended Attributes Dataset. |
2 |
|
|
|
|
|
A,P |
|
A,P |
|
GS_ALIAS Use this to specify alias info instead of normal. |
|
l |
l |
l |
|
|
|
|
l |
|
GS_ALT_FLAG Base/Alternate record
|
2 |
|
|
l |
|
|
l |
|
A |
|
GS_APN_ID Assessor’s Parcel Number (APN) Note: This field is only available with the MLD Extended Attributes Dataset. |
51 |
|
|
|
|
|
A,P |
|
|
|
GS_AUX_USERDATA User data from the auxiliary file. Blank if no auxiliary file. |
301 |
|
|
|
|
|
l |
|
l |
|
GS_BEARING Compass direction, in decimal degrees, from the point data match to the centerline match. Measured clockwise from 0 degrees north. |
6 |
|
|
|
|
|
|
l |
|
|
GS_BLOCK 15-digit census block ID/census FIPS code, using the syntax
sscccttttttgbbb where:
If the address is on the left side of the street, GS_BLOCK will contain the equivalent of GS_BLOCK_LEFT. If the address is on the right, GS_BLOCK will contain the equivalent of GS_BLOCK_RIGHT. Note: GeoStan does not return a period for the Census Tract FIPS Code, this may deviate from the industry standard. |
16 |
|
|
|
|
|
A |
|
A |
GS_BLOCK_2010 15-digit 2010 Census Block ID Note: This field is only available with the MLD Extended Attributes Dataset. |
16 |
A,P |
|||||||
|
GS_BLOCK_LEFT Census block ID from the left side of the street. |
16 |
|
l |
l |
|
|
l |
l |
l |
|
GS_BLOCK_LEFT2 GS_BLOCK_LEFT for the second segment in the intersection. |
16 |
|
|
|
|
|
I |
|
I |
|
GS_BLOCK_RIGHT Census block ID from the right side of the street. |
16 |
|
l |
l |
|
|
l |
l |
l |
|
GS_BLOCK_RIGHT2 GS_BLOCK_RIGHT for the second segment in the intersection. |
16 |
|
|
|
|
|
I |
|
I |
|
GS_CART Carrier route. |
5 |
|
|
l |
|
|
A |
|
A |
|
GS_CBSA_DIVISION_NAME The name of the Core Based Statistical Area (CBSA) division in which the address is located. A CBSA division is a metropolitan statistical area with a population of at least 2.5 million that has been subdivided to form smaller groupings of counties referred to as "metropolitan divisions". |
128 |
|
|
|
|
|
l |
|
l |
|
GS_CBSA_DIVISION_NAME2 GS_CBSA_DIVISION_NAME for the second segment in the intersection. |
128 |
|
|
|
|
|
|
|
I |
|
GS_CBSA_DIVISION_NUMBER The code number of the Core Based Statistical Area (CBSA) division in which the address is located. |
6 |
|
|
|
|
|
l |
|
l |
|
GS_CBSA_DIVISION_NUMBER2 GS_CBSA_DIVISION_NUMBER for the second segment in the intersection. |
6 |
|
|
|
|
|
|
|
I |
|
GS_CBSA_NAME The name of the Core Based Statistical Area in which the address is located. A CBSA is a U.S. geographic area defined by the Office of Management and Budget (OMB) based around an urban center of at least 10,000 people and adjacent areas that are socioeconomically tied to the urban center by commuting. |
128 |
|
|
|
|
|
l |
|
l |
|
GS_CBSA_NAME2 GS_CBSA_NAME for the second segment in the intersection. |
128 |
|
|
|
|
|
|
|
I |
|
GS_CBSA_NUMBER The code number of the Core Based Statistical Area (CBSA) in which the address is located. |
6 |
|
|
|
|
|
l |
|
l |
|
GS_CBSA_NUMBER2 GS_CBSA_NUMBER for the second segment in the intersection. |
6 |
|
|
|
|
|
|
|
I |
|
GS_CHECKDIGITb Check digit. |
2 |
|
|
|
|
|
A |
|
|
|
GS_CITY Abbreviated city name from the last line of the input or output address; the value from GS_NAME_CITY or GS_PREF_CITY. |
29 |
|
|
l |
l |
l |
l |
|
l |
|
GS_CITY_SHORT The output city name that appears in GS_LASTLINE_SHORT. This value is determined by logic similar to GS_CITY. Whenever possible, this city name is 13 characters or less. This output city name is determined by CASS rules. This can be either City State Name, City State Name Abbreviation, or Preferred Last Line City State Name. |
29 |
|
|
|
|
|
l |
|
l |
|
GS_CLOSE_MATCH Indicates if the address was a Close match.
|
|
|
|
|
|
|
l |
|
l |
|
GS_COUNTY County FIPS code. (For GsHandleGet and GsMultipleGet this is the USPS county for the Range record. For GsDataGet this is the county from the segment record or the USPS county if matched to a USPS only range.) |
6 |
|
|
l |
|
|
l |
|
l |
|
GS_COUNTY2 GS_COUNTY for the second segment in the intersection. |
6 |
|
|
|
|
|
|
|
I |
|
GS_COUNTY_FIPS County FIPS code |
4 |
|
|
|
|
l |
|
|
|
|
GS_COUNTY_NAME County name. |
128 |
|
|
l |
|
|
l |
|
l |
|
GS_COUNTY_NAME2 GS_COUNTY_NAME for the second segment in the intersection. |
128 |
|
|
|
|
|
|
|
I |
|
GS_CSA_NAME The name of the Combined Statistical Area (CSA) in which the address is located. A CSA consists of two or more adjacent CBSAs that have substantial employment interchange. |
128 |
|
|
|
|
|
l |
|
l |
|
GS_CSA_NAME2 GS_CSA_NAME for the second segment in the intersection. |
128 |
|
|
|
|
|
|
|
I |
|
GS_CSA_NUMBER The code number for the CSA in which the address is located. |
4 |
|
|
|
|
|
l |
|
l |
|
GS_CSA_NUMBER2 GS_CSA_NUMBER for the second segment in the intersection. |
4 |
|
|
|
|
|
|
|
I |
|
GS_CTYST_KEY USPS city state key (an alphanumeric value that uniquely identifies a locale in the USPS city state product). |
7 |
|
|
l |
|
|
l |
|
l |
|
GS_DATATYPE Type of data used to make the match. •0 – USPS data •1 – TIGER data •2 – TomTom street-level data •4 – Deprecated •5 – Deprecated •6 – HERE (formerly NAVTEQ) street-level data •7 – TomTom point-level data •9 – Auxiliary file data •10 – User Dictionary •11 – HERE (formerly NAVTEQ) point-level data •12 – Master Location Data |
3 |
|
l |
|
|
|
l |
l |
l |
|
GS_DATATYPE2 GS_DATATYPE for the second segment in the intersection. |
3 |
|
|
|
|
|
|
|
I |
|
GS_DFLT b Indicates the return status of GS_HI_RISE_DFLT and GS_R_RTE_DFLT •Y – Either GS_HI_RISE_DFLT or GS_R_RTE_DFLT returned Y. •Blank – Both GS_HI_RISE_DFLT and GS_R_RTE_DFLT returned N or Blank. |
2 |
|
|
|
|
|
l |
|
A |
|
GS_DPBCb Delivery Point Bar Code. |
3 |
|
|
|
|
|
A |
|
|
|
GS_DPV_CONFIRM Indicates if a match occurred for DPV data. •N – Nothing confirmed •Y – Everything confirmed (ZIP + 4, primary, and secondary) •S – ZIP + 4 and primary (house number) confirmed •D – ZIP + 4 and primary (house number) confirmed and a default match (GS_HI_RISE_DFLT = Y), secondary did not confirm. •Blank – non-matched input address to USPS ZIP + 4 data, or DPV data not loaded |
2 |
|
|
|
|
|
A |
|
|
|
GS_DPV_CMRA DPV CMRA indicator. •Y – Address found in CMRA table •N – Address not found in CMRA table •Blank – DPV not loaded |
2 |
|
|
|
|
|
A |
|
|
|
GS_DPV_FALSE_POS DPV false-positive indicator. •Y – False-positive match found •Blank – False-positive match not found |
2 |
|
|
|
|
|
A |
|
|
|
GS_DPV_FOOTNOTE1 Information about matched DPV records. •AA – ZIP + 4 matched •A1 – Failure to match a ZIP + 4 •Blank – Address not presented to hash table or DPV data not loaded |
3 |
|
|
|
|
|
A |
|
|
|
GS_DPV_FOOTNOTE2 Information about matched DPV records. •BB – All DPV categories matched •CC – DPV matched primary/house number, where the secondary/unit number did not match (present but invalid) •M1 – Missing primary/house number •M3 – Invalid primary/house number •N1 – DPV matched primary/house number, with a missing secondary number •P1 – Missing PS, RR, or HC Box number •P3 – Invalid PS, RR or HC Box number •F1 – All military addresses •G1 – All general delivery addresses •U1 – All unique ZIP Code addresses •Blank – Address not presented to hash table or DPV data not loaded Note: A unique ZIP Code is a ZIP Code assigned to a company, agency, or entity with sufficient mail volume to receive its own ZIP Code. |
3 |
|
|
|
|
|
A |
|
|
|
GS_DPV_FOOTNOTE3 Information about matched DPV records. •R1 – Matched to CMRA but PMB designator not present. •RR – Matched to CMRA and PMB designator present (PMB 123 or # 123). •Blank – Address not presented to hash table or DPV data not loaded |
3 |
|
|
|
|
|
A |
|
|
|
GS_DPV_FOOTNOTE4 Reserved by USPS for future use. |
3 |
|
|
|
|
|
A |
|
|
|
GS_DPV_FOOTNOTE5 Reserved by USPS for future use. |
3 |
|
|
|
|
|
A |
|
|
|
GS_DPV_FOOTNOTE6 Reserved by USPS for future use. |
3 |
|
|
|
|
|
A |
|
|
|
GS_DPV_NO_STAT •Y - The address is valid for CDS pre-processing. •N - The address is not valid for CDS pre-processing. •Blank - DPV is not loaded or DPV did not confirm. |
2 |
|
|
|
|
|
A |
|
|
|
GS_DPV_SHUTDOWN •Y - Address was found in false-positive table. •N - Address was not found in false-positive table. •Blank - Address was not presented to hash table or DPV data not loaded. |
2 |
|
|
|
|
|
A |
|
|
|
GS_DPV_VACANT •Y - The address is vacant. •N - The address is not vacant. •Blank - DPV is not loaded or DPV did not confirm (so vacancy is irrelevant). |
3 |
|
|
|
|
|
A |
|
|
|
GS_EWS_MATCH Indicates if GeoStan made an EWS match. •Y – Match denied because it matched to EWS data. •Blank – Input record did not match to EWS data. |
2 |
|
|
|
|
|
A |
|
|
|
GS_FIND_NEAREST_MAX_ CANDIDATES Specifies the maximum number of reverse geocoding candidates GeoStan will return. This is an integer value to be set with GsSetPropLong(). The default value is 1. |
|||||||||
|
GS_FIRM_NAME Name of firm from the USPS data or the input firm name. |
41 |
|
|
l |
l |
l |
A |
|
A |
|
GS_GOVT_FLAG Government building indicator. •A – City government building •B – Federal government building •C – State government building •D – Firm-only •E – City government building and firm only •F – Federal government building and firm only •G – State government building and firm only A, B, C, E, F, and G are valid for alternate records only (GS_ALT_FLAG=A). D is valid for both base and alternate records. |
2 |
|
|
l |
|
|
A |
|
A |
|
GS_HI_RISE_DFLT Indicates if GeoStan matched to a highrise. •N – Matched to an exact highrise record or a street record •Y – Did not match to an exact record. Matched to the USPS default highrise record or a street record. Check the input address for accuracy and completeness. •Blank – Does not apply to the input address (for example, PO Boxes and General Delivery addresses) or did not find a match. |
2 |
|
|
|
|
|
A |
|
A |
|
GS_HIRANGE House number at high end of range. |
12 |
|
|
l |
|
|
A |
|
A |
|
GS_HIUNIT High unit number. |
12 |
|
|
l |
|
|
A |
|
A |
|
GS_HIZIP4 High ZIP + 4 for this range. |
5 |
|
|
l |
|
|
|
|
A |
|
GS_HOUSE_NUMBER House number of input or output address. |
12 |
|
|
|
|
l |
A |
|
l |
|
GS_HOUSE_NUMBER2 Second house number for a ranged house number match. If GS_FIND_ADDRESS_RANGE is enabled, the second number in the ranged address. |
12 |
|
|
|
|
l |
A |
|
l |
|
GS_INC_IND Incorporated Place Indicator. •I – Incorporated place •N – Not an incorporated place •X – Unknown Note: This field is only available with the MLD Extended Attributes Dataset. |
2 |
|
|
|
|
|
A, P |
|
A, P |
|
GS_INTERSECTION Indicates if the address is an intersection. •T – Input address is an intersection •F – Input address is a street address |
2 |
|
|
|
|
l |
l |
|
l |
|
GS_IS_ALIAS The first character is: •N – Normal street match •A – Alias match (including buildings, aliases, firms, etc.) The next 2 characters are: •01 – Basic index, normal address match •02 – USPS street name alias index •03 – USPS building index •05 – Statewide intersection alias (when using the Usw.gsi, Use.gsi,or US.gsi file). •06 – Spatial data street name alias (when using the Us_pw.gsi, Usw.gsi, Us_pe.gsi, Use.gsi, Us_ps.gsi, Usp.gsi, Us_psw.gsi, or Us_pse.gsi file is required.) •07 – Alternate index (when using Zip9.gsu, Zip9e.gsu, and Zip9w.gsu) •08 – LACSLink •09 – Auxiliary file match. •10 – Centrus Alias index (when using usca.gsi) •11 – POI index (when using poi.gsi) •12 – USPS Preferred Alias •13 – ZIPMove match (when using us.gsz) •14 – Expanded Centroids match (when using us_cent.gsc) •15 – PPOI index (when using ppoi1.gsi, 2.gsi, 3.gsi) |
4 |
l |
l |
l |
|
|
A |
l |
l |
|
GS_LACS_FLAG Indicates if GeoStan marked the address for conversion. •L – Address marked for LACS conversion. •Blank – Address not marked for LACS conversion. |
2 |
|
|
l |
|
|
A |
|
A |
|
GS_LACSLINK_IND LACSLink indicator. •Y – Matched LACSLink record •N – LACSLink match NOT found •F – False-positive LACSLink record •S – Secondary information (unit number) removed to make a LACSLink match •Blank – Not processed through LACSLink |
2 |
|
|
|
|
|
A |
|
|
|
GS_LACSLINK_SHUTDOWN •Y – False-positive occurred and LACSLink library shutdown. •N – LACSLink library has not shutdown or not loaded. |
2 |
|
|
|
|
|
A |
|
|
|
GS_LACSLINK_RETCODE LACSLink return code. •A – Matched LACSLink record •00 – LACSLink match NOT found •09 – Matched to highrise default, but no LACSLink conversion •14 – Found LACSLink match, but no LACSLink conversion •92 – Secondary information (unit number) removed to make a LACSLink match •Blank – Not processed through LACSLink |
3 |
|
|
|
|
|
A |
|
|
|
GS_LASTLINEc Complete last line (ZIP + 4 not available with GsMultipleGet or intersection matches). |
61 |
|
|
l |
l |
l |
l |
|
l |
|
GS_LASTLINE_SHORT This is the address "lastline". It contains the values of GS_CITY_SHORT, GS_STATE, and GS_ZIP10. Whenever possible, this field is 29 characters or less: •13-character city name •2 (comma and space) •2-character state abbreviation •2 spaces •10-digit ZIP Code |
61 |
|
|
|
|
|
l |
|
|
|
GS_LAT Latitude of located point (in millionths of degrees). |
11 |
|
|
|
l |
|
l |
l |
l |
|
GS_LINE1GS_LINE2GS_LINE3GS_ LINE4GS_LINE5GS_LINE6 Used for multiple line entry. GeoStan does not process these as output. PMB_DESIGNATOR and PMB_NUMBER are not returned in this mode. |
104 |
|
|
|
|
l |
|
|
|
|
GS_LOC_CODE Location code. For descriptions of location codes, see the Status Codes appendix. |
5 |
|
|
|
|
|
l |
|
l |
|
GS_LON Longitude of located point (in millionths of degrees). |
12 |
|
|
|
l |
|
l |
l |
l |
|
GS_LORANGE House number at low end of range. |
12 |
|
|
l |
|
|
A |
|
A |
|
GS_LOT_CODEb •A – Ascending •D – Descending. eLot ascending and descending value. Only available for addresses GeoStan can standardize. |
2 |
|
|
|
|
|
A |
|
|
|
GS_LOT_NUMb 4-digit eLOT number. Requires an input address GeoStan can standardize. |
5 |
|
|
|
|
|
A |
|
|
|
GS_LOTSIZE Lot size of the parcel expressed in square feet; 0 if none. Note: This field is only available with the MLD Extended Attributes Dataset. |
11 |
|
|
|
|
|
A,P |
|
A,P |
|
GS_LOTSIZE_METERS Lot size of the parcel expressed in square meters; 0 if none. Note: This field is only available with the MLD Extended Attributes Dataset. |
11 |
|
|
|
|
|
A,P |
|
A,P |
|
GS_LOUNIT Low unit number. |
12 |
|
|
l |
|
|
A |
|
A |
|
GS_LOZIP4 Low ZIP + 4 for this range. |
5 |
|
|
l |
|
|
|
|
A |
|
GS_MAIL_STOP Returns address information appearing after mail stop designator words: MSC, MS, MAILSTOP, MAIL STOP, ATTN, ATTENTION. |
61 |
|
|
|
|
|
l |
|
|
|
GS_MATCH_CODE Match code. For descriptions of match codes, see the Status Codes appendix. |
5 |
|
|
|
|
|
l |
|
l |
|
GS_MATCHED_DB Index of database for matched record. |
|
|
|
|
|
|
l |
|
l |
|
GS_MCD_NAME Minor Civil Division name from the auxiliary file. Blank if no auxiliary file match. |
41 |
|
|
|
|
|
l |
|
l |
|
GS_MCD_NUMBER Minor Civil Division number from the auxiliary file. Blank if no auxiliary file match. |
6 |
|
|
|
|
|
l |
|
l |
|
GS_METRO_FLAG Indicates if GS_CBSA_NAME •Y – Contains "Metropolitan Statistical Area" •N – Is non-blank but does not contain "Metropolitan Statistical Area" •Blank – Is blank (the county does not contain a CBSA). |
2 |
|
|
|
|
|
l |
|
l |
|
GS_METRO_FLAG2 GS_METRO_FLAG for the second segment in the intersection. |
2 |
|
|
|
|
|
|
|
I |
|
GS_MM_RESULT_CODE Returns a MapMarker style result code. |
12 |
|
|
|
|
|
l
|
|
l |
|
GS_NAME Street name |
41 |
l |
l |
l |
|
l |
l |
l |
l |
|
GS_NAME2 Second street name in an intersection match. |
41 |
|
|
|
|
I |
I |
|
I |
|
GS_NAME_CITY City name for the matched address from the City State record. |
29 |
|
|
|
|
|
l |
|
l |
|
GS_NAME_SHORT The short street name field contains the short street name used to construct the short address line. All attempts are made to abbreviate this name according to the process specified by the USPS in the 30 Character Abbreviation - Cycle M Flow Chart. If an abbreviated address cannot be constructed that is 30 characters or less, this field then contains the same street name value as the GS_NAME field enum return. |
41 |
|
|
|
|
|
l |
|
|
|
GS_NON_DELIVERABLE Indicates if the USPS can deliver mail to the output address. Y - the address is not deliverable by the USPS or the address did not match. N - the address is deliverable by the USPS. |
2 |
A |
|||||||
|
GS_PARCEN_ELEVATION Elevation of the geocode at the parcel centroid in feet. Note: This field is only available with the MLD Extended Attributes Dataset. |
7 |
|
|
|
|
|
A,P |
|
A,P |
|
GS_PARCEN_ELEVATION_ METERS Elevation of the geocode at the parcel centroid (in meters) expressed with 1 digit of decimal precision in meters output. For example: 123.4 meters. Note: This field is only available with the MLD Extended Attributes Dataset. |
7 |
|
|
|
|
|
A,P |
|
A,P |
GS_PARENT_ID Precisely ID of the address without units or blank if there are no units Note: This field is only available with the MLD Extended Attributes Dataset. |
13 |
A,P |
|||||||
|
GS_PB_KEY As an input field used with GsDataSet, this field specifies the PreciselyIDunique identifier is used as input data for matching with Reverse PreciselyID Lookup. For more information, see PreciselyID Fallback. As an output field, this is a unique address identifier returned when an address match is returned from the Master Location Dataset. The leading character is a ‘P’. For example: P00001XSF1IF For a fallback GS_PB_KEY, the leading character is an ‘X’. For more information, see GS_FIND_APPROXIMATE_PBKEY. Fallback PreciselyIDs are not returned using GsHandleGet. Note: This field is only available for the Master Location Dataset. |
13 |
|
A,P* |
|
l |
|
A,P |
|
A,P |
|
GS_PERCENT_GEOCODE Percentage along the street segment to the interpolated match. The range is 0.0 - 100.0. The range is always 0.0 for point data. |
5 |
|
|
|
|
|
R |
|
A |
|
GS_PLACE TIGER Place code; 0 if none. Note: This field is only available with the MLD Extended Attributes Dataset. |
8 |
|
|
|
|
|
A,P |
|
A,P |
|
GS_PMB_DESIGNATOR PMB designator (always "PMB"). Note: Not output when using GS_LINE to set the address. |
5 |
|
|
|
|
|
A |
|
|
|
GS_PMB_NUMBER PMB number. Note: Not output when using GS_LINE to set the address. |
9 |
|
|
|
|
|
A |
|
|
|
GS_POBOX_ZONE Indicates if the ZIP Code has only PO Box addresses. Those addresses can be either a PO Box or a PO Box street address (PBSA). Y - The ZIP Code has only PO Box addresses. N - The ZIP Code does not have only PO Box addresses. |
2 | A |
|||||||
|
GS_POINT_ID Unique point ID of the matched record when matched to point-level data. Blank if the matched record is not from point-level data. |
11 |
|
A,P |
|
|
|
A,P |
|
A,P |
|
GS_POSTDIR Postfix direction. Can be blank, N, S, E, W, NE, NW, SW, or SE. |
3 |
l |
l |
l |
|
l |
l |
l |
l |
|
GS_POSTDIR2 Cross street postfix direction. |
3 |
|
|
|
|
I |
I |
|
I |
|
GS_POSTDIR_SHORT Postdir from the GS_ADDRLINE_SHORT. |
3 |
|
|
|
|
|
l |
|
|
|
GS_PREDIR Prefix direction. Can be blank, N, S, E, W, NE, NW, SW, or SE. |
3 |
l |
l |
l |
|
l |
l |
l |
l |
|
GS_PREDIR2 Cross street prefix direction. |
3 |
|
|
|
|
I |
I |
|
I |
|
GS_PREDIR_SHORT Predir from the GS_ADDRLINE_SHORT. |
3 |
|
|
|
|
|
l |
|
l |
|
GS_PREF_CITY Preferred city name for the output ZIP Code of the matched address. |
29 |
|
|
|
|
|
l |
|
l |
GS_PROPERTY_ACCOUNT_ID County property account ID Note: This field is only available for the Master Location Dataset. |
51 |
A,P |
|||||||
|
GS_QCITY State , city , or finance numbers. |
10 |
l |
l |
l |
|
|
l |
l |
l |
|
GS_R_RTE_DFLT Match indication for rural routes. •N – Matched to an exact rural route record. •Y – Did not find an exact record. Matched to the USPS default rural route record. Check the input address for accuracy and completeness. •Blank – Does not apply to the input address (for example, street addresses, P.O. Boxes, and General Delivery addresses) or no match found. |
2 |
|
|
|
|
|
A |
|
A |
|
GS_RANGE_PARITY Indicates the parity of the house number in the range. •E – Even •O – Odd •B – Both |
41 |
|
|
l |
|
|
|
|
A |
|
GS_RDI_RETCODE USPS Residential Delivery Indicator (requires DPV-confirmed ZIP+4) •Y - Address is a residence •N - Address is a business •Blank - Address was not presented to RDI or RDI data not loaded |
2 |
|
|
|
|
|
A |
|
|
|
GS_REC_TYPEb Range record type. •A – Auxiliary file •F – Firm •G – General delivery •H – Highrise •P – PO Box •R – Rural route/highway contract •S – Street •T – TIGER file •U - User Dictionary |
2 |
|
|
l |
|
|
A |
|
A |
|
GS_RESBUS Usage indicator •R – Residential use •B – Business use •M – Mixed use – residential and business •X – Unknown use Note: This field is only available with the MLD Extended Attributes Dataset. |
2 |
|
|
|
|
|
A,P |
|
A,P |
|
GS_RESOLVED_LINE indicates which line in a 2-line address GeoStan used to resolve the address. Relates to GS_ADDRLINE and GS_ADDR2 with GsDataSet. |
5 |
|
|
|
|
|
l |
|
|
|
GS_ROAD_CLASS Road class code. •0– Minor road, main data file •1 – Major road, main data file •10 – Minor road, supplemental file •11 – Major road, supplemental data file |
3 |
|
l |
l |
|
|
A |
l |
l |
|
GS_ROAD_CLASS2 GS_ROAD_CLASS for the second segment in the intersection. |
3 |
|
|
|
|
|
|
|
I |
|
GS_SEG_HIRANGE High house number in segment. |
12 |
|
l |
l |
|
|
|
l |
l |
|
GS_SEG_HIRANGE2 GS_SEG_HIRANGE for the second segment in the intersection. |
12 |
|
|
|
|
|
|
|
I |
|
GS_SEG_LORANGE Low house number in segment. |
12 |
|
l |
l |
|
|
|
l |
l |
|
GS_SEG_LORANGE2 GS_SEG_LORANGE for the second segment in the intersection. |
12 |
|
|
|
|
|
|
|
I |
|
GS_SEGMENT_DIRECTION •F – Numbers are forward •R – Numbers are reversed |
2 |
|
l |
l |
|
|
|
l |
l |
|
GS_SEGMENT_DIRECTION2 GS_SEGMENT_DIRECTION for the second segment in the intersection. |
2 |
|
|
|
|
|
|
|
I |
|
GS_SEGMENT_ID Segment ID (TLID) or unique ID from premium data vendors. |
11 |
|
l |
l |
|
|
l |
l |
l |
|
GS_SEGMENT_ID2 GS_SEGMENT_ID for the second segment in the intersection. |
11 |
|
|
|
|
|
|
|
I |
|
GS_SEGMENT_PARITY Odd numbers in the segment are on: •L – Left side of the street •R – Right side of the street •B – Both sides of the street •U – Unknown |
2 |
|
l |
l |
|
|
|
l |
l |
|
GS_SEGMENT_PARITY2 GS_SEGMENT_PARITY for the second segment in the intersection. |
2 |
|
|
|
|
|
|
|
I |
|
GS_STATE State abbreviation. |
3 |
l |
l |
l |
l |
l |
l |
|
l |
|
GS_STATE_FIPS State FIPS code. |
3 |
|
|
|
l |
|
|
|
|
|
GS_STREET_SIDE The matched address is on the following side of the street: •L – Left side of the street •R – Right side of the street •B – Both sides of the street •U – Unknown side of the street This is relative to the segment end points and the segment direction (GS_SEGMENT_DIRECTION). Note: This enum does not reflect the value in the "Side of Street" field of any particular data vendor. |
2 |
|
|
|
|
|
l |
|
A |
|
GS_SUITELINK_RET_CODE •A - SuiteLink record match. •00 - No SuiteLink match. •Blank - This address was not processed through SuiteLink. |
4 |
|
|
|
|
|
A |
|
|
|
GS_TFID TIGER Face Identifier. This field can be used to match to all Census geocodes using external data; 0 if none. Note: This field is only available with the MLD Extended Attributes Dataset. |
10 |
|
|
|
|
|
A,P |
|
A,P |
|
GS_TYPE Street type (also called street suffix). |
5 |
l |
l |
l |
|
l |
l |
l |
l |
|
GS_TYPE2 Cross street type. |
5 |
|
|
|
|
I |
I |
|
I |
|
GS_TYPE_SHORT Postdir from the GS_ADDRLINE_SHORT. |
6 |
|
|
|
|
|
l |
|
|
|
GS_UACE TIGER Urban Area Identifier. Defines the urban area if any; 0 if none. Note: This field is only available with the MLD Extended Attributes Dataset. |
6 |
|
|
|
|
|
A,P |
|
A,P |
|
GS_UACEPOP Census population of the urban area; 0 if none. Note: This field is only available with the MLD Extended Attributes Dataset. |
11 |
|
|
|
|
|
A,P |
|
A,P |
|
GS_UNIT_NUMBER Unit number. |
12 |
|
|
|
|
A |
A |
|
A |
|
GS_UNIT_NUMBER2 Second unit number parsed from the address line. Available in CASS and relaxed modes only. |
12 |
|
|
|
|
A |
A |
|
|
|
GS_UNIT_PARITY Indicates the parity of the unit number range (GS_LOUNIT and GS_HIUNIT). •E – Even •O – Odd •B – Both |
2 |
|
|
l |
|
|
|
|
A |
|
GS_UNIT_TYPE Unit type (APT, STE, etc.). |
5 |
|
|
l |
|
A |
A |
|
A |
|
GS_UNIT_TYPE2 Second unit type parsed from the address line. Available in CASS and relaxed modes only. |
5 |
|
|
|
|
A |
A |
|
|
|
GS_URB_NAME Urbanization name for Puerto Rico. |
31 |
|
|
|
l |
l |
l |
|
A |
|
GS_URBANICITY Urbanicity Indicator. An indicator that defines, per the Census, the Urbanicity of the Address using TIGER UACE codes for categorization. •L – Large Urban Area (50,000 or greater population) •S – Small Urban Area (2,500-50,000 population) •R – Rural •X – Unknown Note: This field is only available with the MLD Extended Attributes Dataset. |
2 |
|
|
|
|
|
A,P |
|
A,P |
|
GS_ZIP 5-digit ZIP Code. |
6 |
|
|
l |
l |
A |
l |
|
l |
|
GS_ZIP4b 4-digit ZIP Code extension. |
5 |
|
|
|
l |
A |
A |
|
A |
|
GS_ZIP9c 9-digit ZIP Code (ZIP + 4). |
10 |
|
|
|
l |
A |
A |
|
A |
|
GS_ZIP10c 9-digit ZIP Code (ZIP + 4) with dash separator. |
11 |
|
|
|
l |
A |
A |
|
A |
|
GS_ZIP_CARRTSORT Indicates the type of cart sort allowed. •A – Automation cart allowed, optional cart merging allowed. •B – Automation cart allowed, optional cart merging not allowed. •C – Automation cart not allowed, optional cart merging allowed. •D – Automation cart not allowed, optional cart merging not allowed. |
2 |
|
|
l |
|
|
l |
|
l |
|
GS_ZIP_CITYDELV Indicates if city-delivery is available. •Y – Post office has city-delivery carrier routes •N – Post office does not have city-delivery |
2 |
|
|
l |
|
|
l |
|
l |
|
GS_ZIP_CLASS ZIP Classification Code: •Blank – Standard ZIP Code •M – Military ZIP Code •P – ZIP Code has P.O. Boxes only •U – Unique ZIP Code. (A unique ZIP Code is a ZIP Code assigned to a company, agency, or entity with sufficient mail volume to receive its own ZIP Code.) |
2 |
|
|
l |
|
|
l |
|
l |
|
GS_ZIP_FACILITY Returns USPS City State Name Facility Code. •A – Airport Mail Facility (AMF) •B – Branch •C – Community Post Office (CPO) •D – Area Distribution Center (ADC) •E – Sectional Center Facility (SCF) •F – Delivery Distribution Center (DDC) •G – General Mail Facility (GMF) •K – Bulk Mail Center (BMC) •M – Money Order Unit •N – Non-Postal Community Name, Former Postal Facility, or Place Name •P – Post Office •S – Station •U – Urbanization |
2 |
|
|
l |
|
|
l |
|
l |
|
GS_ZIP_UNIQUE •Y – unique ZIP Code. (ZIP Code assigned to a company, agency, or entity with sufficient mail volume to receive its own ZIP Code.) •Blank – Not applicable. |
2 |
|
|
l |
|
|
l |
|
l |
|
GS_ZIP_VALID Describes if the output ZIP Code is valid. Y: • For matched (coded) addresses. • For a failed address, if the input City/State matches the input ZIP. • For a failed address, if the City/State contains only one ZIP Code, it will be added and the flag set to Y. N: For all other cases. |
2 |
A |
|||||||
aThe length column is not applicable. bBlank if running in CASS mode and you have not initialized DPV or the output address does not DPV confirm. cLast 4 digits are blank if running in CASS mode and you have not initialized DPV or the output address does not DPV confirm. For GsMultipleGet(), GeoStan returns ZIP+4 but only for Address matches. |