This section 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. |
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 |
• | • | • | • | ||||
GS_ADDRLINE_SHORT Shortest possible address line that can be constructed from available short street name and the other address line components. |
61 |
• | |||||||
GS_ADDR2 Second address line. |
61 | • | • | • | |||||
GS_ADDRTYPE Address Type regarding number of units:
This field is only available with the MLD Extended Attributes Dataset. |
2 |
A,M |
A,M |
||||||
GS_ALIAS
Use this to specify alias info instead of normal. |
• | • | • | • | |||||
GS_ALT_FLAG
Base/Alternate record:
|
2 | • | • | A | |||||
GS_APN_ID
Assessor's Parcel Number (APN) This field is only available with the MLD Extended Attributes Dataset. |
51 |
A,M |
A,M | ||||||
GS_AUX_USERDATA
User data from the auxiliary file. Blank if no auxiliary file. |
301 | • | • | ||||||
GS_BEARING
Compass direction, in decimal degrees, from the point data match to the centerline match. Measured clockwise from 0 degrees north. |
6 | • | |||||||
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. 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 |
16 | A,M | |||||||
GS_BLOCK_LEFT
Census block ID from the left side of the street. See GS_BLOCK for more information. |
16 | • | • | • | • | • | |||
GS_BLOCK_LEFT2
This is GS_BLOCK_LEFT for the second segment in the intersection. See GS_BLOCK for more information. |
16 | I | I | ||||||
GS_BLOCK_RIGHT Census block ID from the right side of the street. See GS_BLOCK for more information. |
16 | • | • | • | • | • | |||
GS_BLOCK_RIGHT2 This is GS_BLOCK_RIGHT for the second segment in the intersection. See GS_BLOCK for more information. |
16 |
I |
I |
||||||
GS_CART Carrier route. |
5 |
• | 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 |
• | • | ||||||
GS_CBSA_DIVISION_NAME2 This is 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 |
• | • | ||||||
GS_CBSA_DIVISION_NUMBER2 This is 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 |
• | • | ||||||
GS_CBSA_NAME2 This is 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 |
• | • | ||||||
GS_CBSA_NUMBER2 This is 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 |
• | • | • | • | • | |||
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 |
• | • | ||||||
GS_CLOSE_MATCH Indicates if the address was a Close match.
|
• | • | |||||||
GS_COUNTY Current county FIPS code assigned by the state. This value may be different than the Census County FIPS code from the last US Census which is returned in GS_BLOCK, GS_BLOCK2, GS_BLOCK_LEFT, GS_BLOCK_LEFT2, GS_BLOCK_RIGHT, and GS_BLOCK_RIGHT2.
|
6 |
• | • | • | |||||
GS_COUNTY2 This is GS_COUNTY for the second segment in the intersection. |
6 |
I |
|||||||
GS_COUNTY_FIPS Current county FIPS code assigned by the state. This value may be different than the Census County FIPS code from the last US Census which is returned in GS_BLOCK, GS_BLOCK2, GS_BLOCK_LEFT, GS_BLOCK_LEFT2, GS_BLOCK_RIGHT, and GS_BLOCK_RIGHT2. |
4 |
• | |||||||
GS_COUNTY_NAME County name assigned by the state. |
128 |
• | • | • | |||||
GS_COUNTY_NAME2 This is 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 |
• | • | ||||||
GS_CSA_NAME2 This is 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 |
• | • | ||||||
GS_CSA_NUMBER2 This is GS_CSA_NUMBER for the second segment in the intersection. |
4 |
I |
|||||||
GS_CTYST_KEY This is USPS city state key (an alphanumeric value that uniquely identifies a locale in the USPS city state product). |
7 |
• | • | • | |||||
GS_DATATYPE Type of data used to make the match.
|
3 |
• | • | • | • | ||||
GS_DATATYPE2 This is 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
|
2 | • | A | ||||||
GS_DPBCb Delivery Point Bar Code. |
3 |
A | |||||||
GS_DPV_CONFIRM
Indicates if a match occurred for DPV data.
|
2 | A | |||||||
GS_DPV_CMRA
DPV CMRA indicator.
|
2 | A | |||||||
GS_DPV_FALSE_POS
DPV false-positive indicator.
|
2 | A | |||||||
GS_DPV_FOOTNOTE1
Information about matched DPV records.
|
3 |
A | |||||||
GS_DPV_FOOTNOTE2 Information about matched DPV records.
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.
|
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
|
2 | A | |||||||
GS_DPV_SHUTDOWN
|
2 | A | |||||||
GS_DPV_VACANT
|
3 |
A | |||||||
GS_EWS_MATCH
Indicates if GeoStan made an EWS match.
|
2 | A | |||||||
GS_FIRM_NAME
Name of firm from the USPS data or the input firm name. |
41 |
• | • | • | A | A | |||
GS_GOVT_FLAG
Government building indicator.
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 | • | A | A | |||||
GS_HI_RISE_DFLT
Indicates if GeoStan matched to a highrise.
|
2 | A | A | ||||||
GS_HIRANGE
House number at high end of range. |
12 | • | A | A | |||||
GS_HIUNIT
High unit number. |
12 |
• | A | A | |||||
GS_HIZIP4
High ZIP + 4 for this range. |
5 | • | A | ||||||
GS_HOUSE_NUMBER
House number of input or output address. |
12 | • | A | • | |||||
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 | • | A | • | |||||
GS_INC_IND
Incorporated Place Indicator.
|
2 |
A, M |
A, M |
||||||
GS_INTERSECTION
Indicates if the address is an intersection.
|
2 | • | • | • | |||||
GS_IS_ALIAS
The first character is:
The next 2 characters are:
|
4 |
• | • | • | A | • | • | ||
GS_LACS_FLAG
Indicates if GeoStan marked the address for conversion.
|
2 | • | A | A | |||||
GS_LACSLINK_IND
LACSLink indicator.
|
2 | A | |||||||
GS_LACSLINK_SHUTDOWN
|
2 | A | |||||||
GS_LACSLINK_RETCODE
LACSLink return code.
|
3 |
A | |||||||
GS_LASTLINEc Complete last line (ZIP + 4 not available with GsMultipleGet or intersection matches). |
61 |
• | • | • | • | • | |||
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:
|
61 |
• | |||||||
GS_LAT
Latitude of located point (in millionths of degrees). |
11 |
• | • | • | • | ||||
GS_LINE1 GS_LINE2 GS_LINE3 GS_ LINE4 GS_LINE5 GS_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 |
• | |||||||
GS_LOC_CODE
Location code. For descriptions of location codes, see the Status Codes section. |
5 |
• | • | ||||||
GS_LON
Longitude of located point (in millionths of degrees). |
12 |
• | • | • | • | ||||
GS_LORANGE
House number at low end of range. |
12 |
• | A | A | |||||
GS_LOT_CODEb
|
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. This field is only available with the MLD Extended Attributes Dataset. |
11 |
A,M |
A,M |
||||||
GS_LOTSIZE_METERS
Lot size of the parcel expressed in square meters; 0 if none. This field is only available with the MLD Extended Attributes Dataset. |
11 |
A,M |
A,M |
||||||
GS_LOUNIT
Low unit number. |
12 |
• | A | A | |||||
GS_LOZIP4
Low ZIP + 4 for this range. |
5 |
• | A | ||||||
GS_MAIL_STOP
Returns address information appearing after mail stop designator words: MSC, MS, MAILSTOP, MAIL STOP, ATTN, ATTENTION. |
61 |
• | |||||||
GS_MATCH_CODE
Match code. For descriptions of match codes, see the Status Codes section. |
5 |
• | • | ||||||
GS_MATCHED_DB Index of database for matched record. |
• | • | |||||||
GS_MCD_NAME
Minor Civil Division name from the auxiliary file. Blank if no auxiliary file match. |
41 |
• | • | ||||||
GS_MCD_NUMBER
Minor Civil Division number from the auxiliary file. Blank if no auxiliary file match. |
6 |
• | • | ||||||
GS_METRO_FLAG
Indicates if GS_CBSA_NAME
|
2 | • | • | ||||||
GS_METRO_FLAG2
This is GS_METRO_FLAG for the second segment in the intersection. |
2 |
I |
|||||||
GS_MM_RESULT_CODE
Returns a MapMarker style result code. |
12 |
• | • | ||||||
GS_NAME
Street name |
41 |
• | • | • | • | • | • | • | |
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 |
• | • | ||||||
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 |
• | |||||||
GS_NON_DELIVERABLE
Indicates if the USPS can deliver mail to the output address.
|
2 | A | |||||||
GS_PARCEN_ELEVATION
Elevation of the geocode at the parcel centroid in feet. This field is only available with the MLD Extended Attributes Dataset. |
7 |
A,M |
A,M |
||||||
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. This field is only available with the MLD Extended Attributes Dataset. |
7 |
A,M |
A,M |
||||||
GS_PARENT_ID
Precisely ID of the address without units or blank if there are no units This field is only available with the MLD Extended Attributes Dataset. |
13 |
M |
M | ||||||
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,M* |
• |
A,M |
A,M |
||||
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. This field is only available with the MLD Extended Attributes Dataset. |
8 |
A,M |
A,M |
||||||
GS_PMB_DESIGNATOR
PMB designator (always "PMB"). Not output when using GS_LINE to set the address. |
5 |
A | |||||||
GS_PMB_NUMBER
PMB number. 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).
|
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,M,P |
A,M,P |
A,M,P |
|||||
GS_POSTDIR
Postfix direction. Can be blank, N, S, E, W, NE, NW, SW, or SE. |
3 |
• | • | • | • | • | • | • | |
GS_POSTDIR2
Cross street postfix direction. |
3 |
I |
I |
I |
|||||
GS_POSTDIR_SHORT
Postdir from the GS_ADDRLINE_SHORT. |
3 |
• | |||||||
GS_PREDIR
Prefix direction. Can be blank, N, S, E, W, NE, NW, SW, or SE. |
3 |
• | • | • | • | • | • | • | |
GS_PREDIR2
Cross street prefix direction. |
3 |
I |
I |
I |
|||||
GS_PREDIR_SHORT
Predir from the GS_ADDRLINE_SHORT. |
3 |
• | • | ||||||
GS_PREF_CITY
Preferred city name for the output ZIP Code of the matched address. |
29 |
• | • | ||||||
GS_PROPERTY_ACCOUNT_ID
County property account ID This field is only available for the Master Location Dataset. |
51 |
M |
M | ||||||
GS_QCITY
State , city , or finance numbers. |
10 |
• | • | • | • | • | • | ||
GS_R_RTE_DFLT
Match indication for rural routes.
|
2 | A | A | ||||||
GS_RANGE_PARITY
Indicates the parity of the house number in the range.
|
41 |
• | A | ||||||
GS_RDI_RETCODE
USPS Residential Delivery Indicator (requires DPV-confirmed ZIP+4)
|
2 | A | |||||||
GS_REC_TYPEb Range record type.
|
2 | • | A | A | |||||
GS_RESBUS
Usage indicator
This field is only available with the MLD Extended Attributes Dataset. |
2 |
A,M |
A,M |
||||||
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 |
• | |||||||
GS_ROAD_CLASS
Road class code.
|
3 |
• | • | A | • | • | |||
GS_ROAD_CLASS2
GS_ROAD_CLASS for the second segment in the intersection. |
3 |
I |
|||||||
GS_SEG_HIRANGE
High house number in segment. |
12 |
• | • | • | • | ||||
GS_SEG_HIRANGE2
GS_SEG_HIRANGE for the second segment in the intersection. |
12 |
I |
|||||||
GS_SEG_LORANGE
Low house number in segment. |
12 |
• | • | • | • | ||||
GS_SEG_LORANGE2
This is GS_SEG_LORANGE for the second segment in the intersection. |
12 |
I |
|||||||
GS_SEGMENT_DIRECTION
|
2 | • | • | • | • | ||||
GS_SEGMENT_DIRECTION2
This is 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 |
• | • | • | • | • | |||
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:
|
2 | • | • | • | • | ||||
GS_SEGMENT_PARITY2
This is GS_SEGMENT_PARITY for the second segment in the intersection. |
2 |
I |
|||||||
GS_STATE
State abbreviation. |
3 |
• | • | • | • | • | • | • | |
GS_STATE_FIPS
State FIPS code. |
3 |
• | |||||||
GS_STREET_SIDE
The matched address is on the following side of the street:
This is relative to the segment end points and the segment direction (GS_SEGMENT_DIRECTION). This enum does not reflect the value in the "Side of Street" field of any particular data vendor. |
2 | • | A | ||||||
GS_SUITELINK_RET_CODE
|
4 |
A | |||||||
GS_TFID The TIGER Face Identifier. This field can be used to match to all Census geocodes using external data. 0 if none. This field is only available with the MLD Extended Attributes Dataset. |
10 |
A,M |
A,M |
||||||
GS_TYPE
Street type (also called street suffix). |
5 |
• | • | • | • | • | • | • | |
GS_TYPE2
Cross street type. |
5 |
• | • | • | |||||
GS_TYPE_SHORT
Postdir from the GS_ADDRLINE_SHORT. |
6 |
• | |||||||
GS_UACE
TIGER Urban Area Identifier. Defines the urban area if any; 0 if none. This field is only available with the MLD Extended Attributes Dataset. |
6 |
A,M |
A,M |
||||||
GS_UACEPOP
Census population of the urban area; 0 if none. This field is only available with the MLD Extended Attributes Dataset. |
11 |
A,M |
A,M |
||||||
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).
|
2 | • | A | ||||||
GS_UNIT_TYPE
Unit type (APT, STE, etc.). |
5 |
• | 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 |
• | • | • | A | ||||
GS_URBANICITY
Urbanicity Indicator. An indicator that defines, per the Census, the Urbanicity of the Address using TIGER UACE codes for categorization.
This field is only available with the MLD Extended Attributes Dataset. |
2 |
A,M |
A,M |
||||||
GS_ZIP
5-digit ZIP Code. |
6 |
• | • | A | • | • | |||
GS_ZIP4b 4-digit ZIP Code extension. |
5 |
• | A | A | A | ||||
GS_ZIP9c 9-digit ZIP Code (ZIP + 4). |
10 |
• | A | A | A | ||||
GS_ZIP10c 9-digit ZIP Code (ZIP + 4) with dash separator. |
11 |
• | A | A | A | ||||
GS_ZIP_CARRTSORT
Indicates the type of cart sort allowed.
|
2 | • | 1 | • | |||||
GS_ZIP_CITYDELV
Indicates if city-delivery is available.
|
2 | • | • | • | |||||
GS_ZIP_CLASS
ZIP Classification Code:
|
2 | • | • | • | |||||
GS_ZIP_FACILITY
Returns USPS City State Name Facility Code:
|
2 | • | • | • | |||||
GS_ZIP_UNIQUE
|
2 | • | • | • | |||||
GS_ZIP_VALID
Describes if the output ZIP Code is valid. 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. |