Global Address Object:Output Parameters: Difference between revisions
No edit summary |
No edit summary |
||
| Line 174: | Line 174: | ||
===dependentThoroughfareConjunction=== | ===dependentThoroughfareConjunction=== | ||
===dependentThoroughfareLeadingType=== | ===dependentThoroughfareLeadingType=== | ||
Thoroughfare type at the beginning of the dependent thoroughfare. The leading type is parsed from the '''dependentThoroughfare''' parameter. For example, if the dependent thoroughfare is "St. Hickory E," the dependent thoroughfare leading type would be "St." | |||
===dependentThoroughfareName=== | ===dependentThoroughfareName=== | ||
| Line 183: | Line 183: | ||
===dependentThoroughfarePreDirection=== | ===dependentThoroughfarePreDirection=== | ||
Cardinal directional at the beginning of the dependent thoroughfare. The prefix directional is parsed from the '''dependentThoroughfare''' parameter. For example, if the dependent thoroughfare is "W Hickory Ln," the dependent thoroughfare pre direction would be "W." | |||
===dependentThoroughfareTrailingType=== | ===dependentThoroughfareTrailingType=== | ||
Thoroughfare type at the end of the dependent thoroughfare. The trailing type is parsed from the '''dependentThoroughfare''' parameter. For example, if the dependent thoroughfare is "W Hickory Ln," the dependent thoroughfare trailing type would be "Ln." | |||
===dependentThoroughfareTypeAttached=== | ===dependentThoroughfareTypeAttached=== | ||
| Line 195: | Line 195: | ||
'''US Only'''. A grouping of households served by an individual mail carrier within a five-digit zip code area. | '''US Only'''. A grouping of households served by an individual mail carrier within a five-digit zip code area. | ||
===parsedPrivateMailboxName=== | ===parsedPrivateMailboxName=== | ||
Private mailbox name. For example, if the street address is "Hickory St. PMB 42," the private mailbox name would be "PMB." | |||
===parsedPrivateMailboxNumber=== | ===parsedPrivateMailboxNumber=== | ||
Private mailbox number. For example, if the street address is "Hickory St. PMB 42," the private mailbox number would be "42." | |||
===postBox=== | ===postBox=== | ||
Post box information for a particular delivery point. | Post box information for a particular delivery point. | ||
| Line 252: | Line 253: | ||
===addressTypeString=== | ===addressTypeString=== | ||
One-character code for the type of address coded. This is only for US and Canadian addresses. | |||
====US Address Type Codes==== | |||
{|class="alternate01 sortable" cellspacing="0" | |||
!Code | |||
!Description | |||
|- | |||
|A | |||
|Alias | |||
|- | |||
|F | |||
|Firm or Company | |||
|- | |||
|G | |||
|General Delivery | |||
|- | |||
|H | |||
|Highrise or Business Complex | |||
|- | |||
|P | |||
|PO Box | |||
|- | |||
|R | |||
|Rural Route | |||
|- | |||
|S | |||
|Street or Residential | |||
|} | |||
====Canadian Address Type Codes==== | |||
{|class="alternate01 sortable" cellspacing="0" | |||
!Code | |||
!Description | |||
|- | |||
|1 | |||
|Street | |||
|- | |||
|2 | |||
|Street Served by Route and GD | |||
|- | |||
|3 | |||
|Lock Box | |||
|- | |||
|4 | |||
|Route Service | |||
|- | |||
|5 | |||
|General Delivery | |||
|- | |||
|B | |||
|LVR Street | |||
|- | |||
|C | |||
|Government Street | |||
|- | |||
|D | |||
|LVR Lock Box | |||
|- | |||
|E | |||
|Government Lock Box | |||
|- | |||
|L | |||
|LVR General Delivery | |||
|- | |||
|K | |||
|Building | |||
|} | |||
===deliveryline=== | ===deliveryline=== | ||
Delivery address. The delivery line is only the street address and dependent locality. It will not contain locality, administrative area, postal code, etc. The delivery line with the locality line equal the full address. | |||
===formattedAddress=== | ===formattedAddress=== | ||
Mailing address. The full mailing address in the preferred format for the country of the address. | |||
===latitude=== | ===latitude=== | ||
North-south geographic coordinate for a particular delivery point. | |||
===localityLine=== | ===localityLine=== | ||
Area information. The locality line is only the locality, administrative area, postal code, etc. It will not contain the street address and dependent locality. The locality line with the delivery line equal the full address. | |||
===longitude=== | ===longitude=== | ||
East-west geographic coordinate for a particular delivery point. | |||
Revision as of 21:42, 11 September 2014
← 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 will contain the full output address in the preferred format for that country.
addressLine2
addressLine3
addressLine4
addressLine5
addressLine6
addressLine7
addressLine8
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.
thoroughfareTypeAttached
Thoroughfare type connected to the thoroughfare name without a space. This is common in Germany. For example, "Berlinerstr." "str." stands for strasse and is the thoroughfare type attached, while "Berliner" is the thoroughfare name.
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.
dependentThoroughfareConjunction
dependentThoroughfareLeadingType
Thoroughfare type at the beginning of the dependent thoroughfare. The leading type is parsed from the dependentThoroughfare parameter. For example, if the dependent thoroughfare is "St. Hickory E," the dependent thoroughfare leading type would be "St."
dependentThoroughfareName
Dependent thoroughfare name parsed from the dependentThoroughfare parameter. For example, if the dependent thoroughfare is "E Hickory Ln," the dependent thoroughfare name would be "Hickory."
dependentThoroughfarePostDirection
Cardinal directional at the end of the dependent thoroughfare. The postfix directional is parsed from the dependentThoroughfare parameter. For example, if the dependent thoroughfare is "Hickory Ln N," the dependent thoroughfare post direction would be "N."
dependentThoroughfarePreDirection
Cardinal directional at the beginning of the dependent thoroughfare. The prefix directional is parsed from the dependentThoroughfare parameter. For example, if the dependent thoroughfare is "W Hickory Ln," the dependent thoroughfare pre direction would be "W."
dependentThoroughfareTrailingType
Thoroughfare type at the end of the dependent thoroughfare. The trailing type is parsed from the dependentThoroughfare parameter. For example, if the dependent thoroughfare is "W Hickory Ln," the dependent thoroughfare trailing type would be "Ln."
dependentThoroughfareTypeAttached
Dependent thoroughfare type connected to the dependent thoroughfare name without a space. This is common in Germany. For example, "Berlinerstr." "str." stands for strasse and is the dependent thoroughfare type attached, while "Berliner" is the dependent thoroughfare name.
Parsed Postal Facility Columns
carrierRoute
US Only. A grouping of households served by an individual mail carrier within a five-digit zip code area.
parsedPrivateMailboxName
Private mailbox name. For example, if the street address is "Hickory St. PMB 42," the private mailbox name would be "PMB."
parsedPrivateMailboxNumber
Private mailbox number. For example, if the street address is "Hickory St. PMB 42," the private mailbox number would be "42."
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.
addressTypeString
One-character code for the type of address coded. This is only for US and Canadian addresses.
US Address Type Codes
| Code | Description |
|---|---|
| A | Alias |
| F | Firm or Company |
| G | General Delivery |
| H | Highrise or Business Complex |
| P | PO Box |
| R | Rural Route |
| S | Street or Residential |
Canadian Address Type Codes
| Code | Description |
|---|---|
| 1 | Street |
| 2 | Street Served by Route and GD |
| 3 | Lock Box |
| 4 | Route Service |
| 5 | General Delivery |
| B | LVR Street |
| C | Government Street |
| D | LVR Lock Box |
| E | Government Lock Box |
| L | LVR General Delivery |
| K | Building |
deliveryline
Delivery address. The delivery line is only the street address and dependent locality. It will not contain locality, administrative area, postal code, etc. The delivery line with the locality line equal the full address.
formattedAddress
Mailing address. The full mailing address in the preferred format for the country of the address.
latitude
North-south geographic coordinate for a particular delivery point.
localityLine
Area information. The locality line is only the locality, administrative area, postal code, etc. It will not contain the street address and dependent locality. The locality line with the delivery line equal the full address.
longitude
East-west geographic coordinate for a particular delivery point.
Extra Output Country Parameters
countryAbbreviation
countryCode
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.