Global Address Object:Output Parameters

← Global Address Object Reference

Though they are listed in mixed case, the parameters are not case sensitive.

Output Detail Parameters

buildNumber

Build number of the Global Address Object API.

databaseDate

Release date of the database.

databaseExpirationDate

Expiration date of the database.

dst

A true/false value delineating if the given address is in a time zone that supports Daylight Savings Time (DST).

initializeErrorString

An error string detailing any failure or error in initializing the reference data file(s) and/or Global Address Object.

licensedCountries

A list of countries licensed for the license string set with SetLicenseString.

licenseStringExpirationDate

Expiration date for the license string set with SetLicenseString.

remnants

Any elements parsed from the input address data which could not be processed or were not relevant to the address processing are returned in the remnant parameter.

resultCodes

Result code(s) generated for the address. Reference |Returned Result Codes for more information.

timezone

Name of the timezone of the address.

utc

Coordinated Universal Time (Universal Time Coordinated). Code that designates the UTC offset for the given time zone of the address. This does not indicate differences due to daylight savings time.

Output Address Parameters

organization

Business or Company

addressLine1

Adress Lines 1-8 contain the unparsed address input.

country

The country of the address.

Parsed Sub-Premises Parameters

building

Descriptive name identifying an individual location.

subPremises

Suite. Alphanumeric code identifying an individual location.

subPremisesNumber

Suite Number. Sub premises number indicator within premises field. Parsed from the subPremises parameter.

subPremisesType

Suite Name. Sub premises type indicator within premises field. Parsed from the subPremises parameter.

Parsed Thoroughfare Parameters

premises

Street Number.

premisesNumber

Alphanumeric indicator within premises field. Parsed from the premises parameter.

premisesType

Leading premise type indicator within premises field. Parsed from the premises parameter.

thoroughfare

Street. Most common street or block data element.

thoroughfareLeadingType

Leading thoroughfare type indicator parsed from the thoroughfare parameter.

thoroughfareName

Street Name. Name indicator parsed from the thoroughfare parameter.

thoroughfarePostDirection

Street Post Direction. Postfix directional parsed from the thoroughfare parameter.

thoroughfarePreDirection

Street PreDirection. Prefix directional parsed from the thoroughfare parameter.

thoroughfareTrailingType

Street Suffix. Trailing thoroughfare type indicator parsed from the thoroughfare parameter.

Parsed Dependent Thoroughfare Columns

dependentThoroughfare

Dependent street or block data element. This is used when there are more than one thoroughfares with the same name in one locality. An adjoining thoroughfare is used to uniquely identify the target thoroughfare.

dependentThoroughfareLeadingType

Leading thoroughfare type indicator parsed from the dependentThoroughfare parameter.

dependentThoroughfarePostDirection

Postfix directional parsed from the dependentThoroughfare parameter.

Parsed Postal Facility Columns

carrierRoute

US Only. A grouping of households served by an individual mail carrier within a five-digit zip code area.

postBox

Post box information for a particular delivery point.

postalCode

Zip (Plus 4). Complete postal code for a particular delivery point. In U.S. plus 4 is not required but will be appended if address is verified.

zipType

US Only. Specifies one of four types of ZIP codes: Unique, PO Box Only, Military, or Standard.

Parsed Regional Columns

administrativeArea

State. Most common geographic data element.

cityAbbreviation

US Only. Official USPS abbreviation for the city or municipality name.

congressionalDistrict

US Only. Population-based. Congressional District of the address.

countyFips

US Only. Six-digit Federal Information Processing Standard (FIPS) code for the county.

countyName

US Only. Sub Administrative Area. Smallest geographic data element.

dependentLocality

Urbanization. Smaller population center data element. Dependent on Locality.

doubleDependentLocality

Smallest population center data element.

locality

City. Most common population center data element.

subAdministrativeArea

County. Smallest geographic data element.

subNationalArea

Arbitrary administrative region below that of the sovereign state.

urbanization

US Only. Dependent Locality. Smaller population center data element. Dependent on Locality.

Extra Output Address Parameters

addressKey

Unique key generated for the address. Can be used by other Melissa Data products.

addressTypeCode

One-character code for the type of address coded.

latitude

Geographic coordinate for a particular delivery point.

longitude

Geographic coordinate for a particular delivery point.

Extra Output Country Parameters

countryName

Full country name.

iso2Code

ISO 3166 2-character country code.

iso3Code

ISO 3166 3-character country code.

isoCountryNumber

ISO 3166 3-digit numeric country code.