Global Address Object:Output Parameters

From Melissa Data Wiki
(Difference between revisions)
Jump to: navigation, search
 
Line 300: Line 300:
  
 
==Extra Output Country Parameters==
 
==Extra Output Country Parameters==
<h3 class="h3grey">countryCode</h3>
 
 
 
 
<h3 class="h3grey">countryName</h3>
 
<h3 class="h3grey">countryName</h3>
 
:Full country name. Can be a nickname.
 
:Full country name. Can be a nickname.

Latest revision as of 13:12, 11 February 2020

← Global Address Object Reference

Global Address Object Navigation
Introduction
System Requirements
Setup
Licensing
Interface
Address Handling
Interface Use
Methods
Setup Methods
Input Methods
Processing Methods
Output Methods
Parameters
Input Parameters
Output Parameters
Result Codes
Global Address Object Result Codes
Other Codes


Contents



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

[edit] 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.


licenseStringExpirationDate

Expiration date for the License Key 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 Global Address Object 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.


[edit] Output Address Parameters

organization

This is a string value that matches the Organization request element. It is not modified or populated by the service.
US Term: Business or Company


addressLine1

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.


addressLine2

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.


addressLine3

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.


addressLine4

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.


addressLine5

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.


addressLine6

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.


addressLine7

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.


addressLine8

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.


deliveryLine

The delivery portion of the full address, from the sub-premise and house number to the street information. This does not include area information like doubledependent locality, dependent locality, locality, administrative area, and postal code if those values are available for the country.


localityLine

The locality information of the full address. This includes information such as doubledependent locality, dependent locality, locality, administrative area, and postal code if those values are available for the country. This does not include sub-premise and house number to the thoroughfare information.


formattedAddress

Mailing address. The full mailing address in the preferred format for the country of the address. This includes the Organization as the first line, one or more lines in the origin country’s format, and the destination country (if required). Separate lines will be delimited by what is specified in the option.


[edit] Parsed Sub-Premises Parameters

building

Descriptive name identifying an individual location. This is a string value that is the parsed Building element from the output.


subBuilding

Descriptive name identifying an individual location. More specific than building. This is a string value that is the parsed premisesType parameter from the output.


subBuildingNumber

Sub building number indicator within building field. Parsed from the subBuilding parameter.


subBuildingType

Sub building type indicator within building field. Parsed from the subBuilding parameter.


subPremises

Alphanumeric code identifying an individual location. More specific than premises.
US Term: Suite


subPremisesNumber

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


subPremisesType

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


subPremisesLevel

Alphanumeric code identifying an individual location. More specific than sub premises.


subPremisesLevelNumber

Sub premises level number indicator within premises field. Parsed from the subPremisesLevel parameter.


subPremisesLevelType

Sub premises level type indicator within premises field. Parsed from the subPremisesLevel parameter.


[edit] Parsed Thoroughfare Parameters

premises

US Term: Street Number


premisesNumber

Alphanumeric indicator within premises field. Parsed from the premises parameter.
US Term: House Number


premisesType

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


thoroughfare

This value is a part of the address lines and contains all the sub-elements of the thoroughfare like trailing type, thoroughfare name, pre direction, post direction, etc.
US Term: Street


thoroughfareLeadingType

Leading thoroughfare type indicator parsed from the thoroughfare parameter. A leading type is a thoroughfare type that is placed before the thoroughfare. This value is a part of the Thoroughfare field. For example, the thoroughfare type of "Rue" in Canada and France is placed before the thoroughfare, making it a leading type.
US Term: Not used in the US


thoroughfareName

Name indicator parsed from the thoroughfare parameter.
US Term: Street Name


thoroughfarePostDirection

Postfix directional parsed from the thoroughfare parameter.
US Term: Post Direction


thoroughfarePreDirection

Prefix directional parsed from the thoroughfare parameter.
US Term: Pre Direction


thoroughfareTrailingType

Trailing thoroughfare type indicator parsed from the thoroughfare parameter. A trailing type is a thoroughfare type that is placed after the thoroughfare. This value is a part of the Thoroughfare field. For example, the thoroughfare type of "Avenue" in the US is placed after the thoroughfare, making it a trailing type.
US Term: Street Suffix


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.


[edit] Parsed Dependent Thoroughfare Columns

dependentThoroughfare

Block data element or dependent street. 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. This is rarely used.
US Term: Dependent Street


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.


[edit] Parsed Postal Facility Columns

postBox

Post box information for a particular delivery point.


postalCode

Complete postal code for a particular delivery point. In U.S. plus 4 is not required but will be appended if address is verified. Most countries have some form of a postal code system.
US Term: Zip Code


personalID

Used by certain Post Offices to identify a recipient for a package.


postOfficeLocation


[edit] Parsed Regional Columns

administrativeArea

This is a common geographic area unit for larger countries. Often referred to as State or Province.
US Term: State


countyName

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


dependentLocality

A dependent locality is a logical area unit that is smaller than a locality but larger than a double dependent locality or thoroughfare. It can often be associated with a neighborhood or sector. Great Britain is an example of a country that uses double dependent locality. In the United States, this would correspond to Urbanization, which is used only in Puerto Rico.
US Term: Urbanization


doubleDependentLocality

A double dependent locality is a logical area unit that is smaller than a dependent locality but bigger than a thoroughfare. This field is very rarely used. Great Britain is an example of a country that uses double dependent locality.


locality

This is the most common geographic area and used by virtually all countries. This is usually the value that is written on a mailing label and referred to by terms like City, Town, Postal Town, etc.
US Term: City


subAdministrativeArea

This is a logical area that that is smaller than the administrative area but larger than a locality. While many countries can have a sub-administrative area value, it is very rarely used as part of an official address.
US Term: County


subNationalArea

A sub-national area is a logical area unit that is larger than an administrative area but smaller than the country itself. It is extremely rarely used.


[edit] Extra Output Address Parameters

latitude

North-south geographic coordinate for a particular delivery point.


longitude

East-west geographic coordinate for a particular delivery point.


[edit] Extra Output Country Parameters

countryName

Full country name. Can be a nickname.


iso2Code

ISO 3166 2-character country code.
For example:
Country Code
United States US
Canada CA
Philippines PH


iso3Code

ISO 3166 3-character country code.
For example:
Country Code
United States USA
Canada CAN
Philippines PHL


isoCountryNumber

ISO 3166 3-digit numeric country code.
For example:
Country Code
United States 840
Canada 124
Philippines 608


formalCountryName

Official Name for the country.


[edit] US Only Output Parameters

USCityAbbreviation

Get the abbreviated city name.


USPlus4

Get the plus4 by itself.


USCarrierRoute

Get the Carrier Route.


USDeliveryPointCode

Get the 2 digit delivery point code


USDeliveryPointCheckDigit

Get the 1 digit devliery point check digit


USCongressionalDistrict

Get the congressional district number of the address


DeliveryIndicator

Returns an “R” for residential, “B” for business, “U” for Unknown


USCensusTract

Census Tract value


USCensusBlock

Census Block value


USBlockSuffix

Census Block Suffix


USCountyFips

County FIPS number


USCountyName

County Name


USPlaceCode

Census Place Code


USPlaceName

Census Place Name


USCBSACode

Census CBSA Code


USCBSATitle

Census CBSA Title


USCBSALevel

Census CBSA Level


USCBSADivisionCode

Census CBSA Division Code


USCBSADivisionTitle

Census CBSA Division Title


USCBSADivisionLevel

Census CBSA Division Level


USCensusKey

Census Key value


USCountySubdivisionCode

Census County Subdivision Code


USCountySubdivisionName

Census County Subdivision Name


USElementarySchoolDistrictCode

Elementary School District Code


USElementarySchoolDistrictName

Elementary School District Name


USSecondarySchoolDistrictCode

Secondary School District Code


USSecondarySchoolDistrictName

Secondary School District Name


USUnifiedSchoolDistrictCode

Secondary School District Code


USUnifiedSchoolDistrictName

Secondary School District Name


USStateDistrictLower

State Lower Congressional District Number


USStateDistrictUpper

State Upper Congressional District Number


USZipType

Returns the Zip Type for US
Code Description
A blank zip type is a regular zip
P Zip code specifically for PO Boxes
U Unique Zip Code
M Military Zip Code


[edit] US and CANADA Output Parameters

AddressType

Returns the Address Type for US and Canada

[edit] US Address Type Codes

Please see the Global Address Object Result Codes for a list of these codes.

[edit] Canadian Address Type Codes

Please see the Global Address Object Result Codes for a list of these codes.


MAK

Melissa Address Key value. MAK is our proprietary unique number for each individual address in the world. Currently only available in the US and CA but we are planning on rapidly adding more.


BaseMAK

Melissa Base Address Key value. The BaseMAK is the MAK of a base building. For example, if there is a high rise with 100 individual suites, they would have 100 unique MAK values. However, all 100 would have the same BaseMAK value which is the address high rise building itself.
Personal tools
Namespaces

Variants
Actions
Navigation
Products
Support