Global Address Object:Output Parameters: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
← Older editNewer edit →
No edit summary
No edit summary
Line 53: Line 53:
==Output Address Parameters==
==Output Address Parameters==
<h3 style="background-color:rgb(240,240,240);">organization</h3>
<h3 style="background-color:rgb(240,240,240);">organization</h3>
'''''Business''''' or '''''Company'''''. This is a string value that matches the Organization request element. It is not modified or populated by the service.
:'''''Business''''' or '''''Company'''''. This is a string value that matches the Organization request element. It is not modified or populated by the service.




<h3 style="background-color:rgb(240,240,240);">addressLine1</h3>
<h3 style="background-color:rgb(240,240,240);">addressLine1</h3>
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.
: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.




<h3 style="background-color:rgb(240,240,240);">addressLine2</h3>
<h3 style="background-color:rgb(240,240,240);">addressLine2</h3>
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.
: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.




<h3 style="background-color:rgb(240,240,240);">addressLine3</h3>
<h3 style="background-color:rgb(240,240,240);">addressLine3</h3>
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.
: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.




<h3 style="background-color:rgb(240,240,240);">addressLine4</h3>
<h3 style="background-color:rgb(240,240,240);">addressLine4</h3>
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.
: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.




<h3 style="background-color:rgb(240,240,240);">addressLine5</h3>
<h3 style="background-color:rgb(240,240,240);">addressLine5</h3>
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.
: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.




<h3 style="background-color:rgb(240,240,240);">addressLine6</h3>
<h3 style="background-color:rgb(240,240,240);">addressLine6</h3>
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.
: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.




<h3 style="background-color:rgb(240,240,240);">addressLine7</h3>
<h3 style="background-color:rgb(240,240,240);">addressLine7</h3>
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.
: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.




<h3 style="background-color:rgb(240,240,240);">addressLine8</h3>
<h3 style="background-color:rgb(240,240,240);">addressLine8</h3>
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.
: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.




<h3 style="background-color:rgb(240,240,240);">deliveryLine</h3>
<h3 style="background-color:rgb(240,240,240);">deliveryLine</h3>
The delivery portion of the full address, from the sub-premise and house number to the dependent locality. Does not include area information like locality, administrative area, and postal code.
:The delivery portion of the full address, from the sub-premise and house number to the dependent locality. Does not include area information like locality, administrative area, and postal code.




<h3 style="background-color:rgb(240,240,240);">formattedAddress</h3>
<h3 style="background-color:rgb(240,240,240);">formattedAddress</h3>
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.
: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.




==Parsed Sub-Premises Parameters==
==Parsed Sub-Premises Parameters==
<h3 style="background-color:rgb(240,240,240);">building</h3>
<h3 style="background-color:rgb(240,240,240);">building</h3>
Descriptive name identifying an individual location. This is a string value that is the parsed Building element from the output.
:Descriptive name identifying an individual location. This is a string value that is the parsed Building element from the output.




<h3 style="background-color:rgb(240,240,240);">subBuilding</h3>
<h3 style="background-color:rgb(240,240,240);">subBuilding</h3>
Descriptive name identifying an individual location. More specific than building. This is a string value that is the parsed '''premisesType''' parameter from the output.
:Descriptive name identifying an individual location. More specific than building. This is a string value that is the parsed '''premisesType''' parameter from the output.




<h3 style="background-color:rgb(240,240,240);">subBuildingNumber</h3>
<h3 style="background-color:rgb(240,240,240);">subBuildingNumber</h3>
Sub building number indicator within building field. Parsed from the '''subBuilding''' parameter.
:Sub building number indicator within building field. Parsed from the '''subBuilding''' parameter.




<h3 style="background-color:rgb(240,240,240);">subBuildingType</h3>
<h3 style="background-color:rgb(240,240,240);">subBuildingType</h3>
Sub building type indicator within building field. Parsed from the '''subBuilding''' parameter.
:Sub building type indicator within building field. Parsed from the '''subBuilding''' parameter.




<h3 style="background-color:rgb(240,240,240);">subPremises</h3>
<h3 style="background-color:rgb(240,240,240);">subPremises</h3>
Alphanumeric code identifying an individual location. More specific than premises.
:Alphanumeric code identifying an individual location. More specific than premises.


'''US Term:''' Suite
:'''US Term:''' Suite




<h3 style="background-color:rgb(240,240,240);">subPremisesNumber</h3>
<h3 style="background-color:rgb(240,240,240);">subPremisesNumber</h3>
Sub premises number indicator within premises field. Parsed from the '''subPremises''' parameter.
:Sub premises number indicator within premises field. Parsed from the '''subPremises''' parameter.


'''US Term:''' Suite Number
:'''US Term:''' Suite Number




<h3 style="background-color:rgb(240,240,240);">subPremisesType</h3>
<h3 style="background-color:rgb(240,240,240);">subPremisesType</h3>
Sub premises type indicator within premises field. Parsed from the '''subPremises''' parameter.
:Sub premises type indicator within premises field. Parsed from the '''subPremises''' parameter.


'''US Term:''' Suite Name
:'''US Term:''' Suite Name




<h3 style="background-color:rgb(240,240,240);">subPremisesLevel</h3>
<h3 style="background-color:rgb(240,240,240);">subPremisesLevel</h3>
Alphanumeric code identifying an individual location. More specific than sub premises.
:Alphanumeric code identifying an individual location. More specific than sub premises.




<h3 style="background-color:rgb(240,240,240);">subPremisesLevelNumber</h3>
<h3 style="background-color:rgb(240,240,240);">subPremisesLevelNumber</h3>
Sub premises level number indicator within premises field. Parsed from the '''subPremisesLevel''' parameter.
:Sub premises level number indicator within premises field. Parsed from the '''subPremisesLevel''' parameter.




<h3 style="background-color:rgb(240,240,240);">subPremisesLevelType</h3>
<h3 style="background-color:rgb(240,240,240);">subPremisesLevelType</h3>
Sub premises level type indicator within premises field. Parsed from the '''subPremisesLevel''' parameter.
:Sub premises level type indicator within premises field. Parsed from the '''subPremisesLevel''' parameter.




==Parsed Thoroughfare Parameters==
==Parsed Thoroughfare Parameters==
<h3 style="background-color:rgb(240,240,240);">premises</h3>
<h3 style="background-color:rgb(240,240,240);">premises</h3>
'''US Term:''' Street Number
:'''US Term:''' Street Number




<h3 style="background-color:rgb(240,240,240);">premisesNumber</h3>
<h3 style="background-color:rgb(240,240,240);">premisesNumber</h3>
Alphanumeric indicator within premises field. Parsed from the '''premises''' parameter.
:Alphanumeric indicator within premises field. Parsed from the '''premises''' parameter.


'''US Term:''' House Number
:'''US Term:''' House Number




<h3 style="background-color:rgb(240,240,240);">premisesType</h3>
<h3 style="background-color:rgb(240,240,240);">premisesType</h3>
Leading premise type indicator within premises field. Parsed from the '''premises''' parameter.
:Leading premise type indicator within premises field. Parsed from the '''premises''' parameter.




<h3 style="background-color:rgb(240,240,240);">thoroughfare</h3>
<h3 style="background-color:rgb(240,240,240);">thoroughfare</h3>
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.
: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
:'''US Term:''' Street




<h3 style="background-color:rgb(240,240,240);">thoroughfareLeadingType</h3>
<h3 style="background-color:rgb(240,240,240);">thoroughfareLeadingType</h3>
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.
: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
:'''US Term:''' Not used in the US




<h3 style="background-color:rgb(240,240,240);">thoroughfareName</h3>
<h3 style="background-color:rgb(240,240,240);">thoroughfareName</h3>
Name indicator parsed from the '''thoroughfare''' parameter.
:Name indicator parsed from the '''thoroughfare''' parameter.


'''US Term:''' Street Name
:'''US Term:''' Street Name




<h3 style="background-color:rgb(240,240,240);">thoroughfarePostDirection</h3>
<h3 style="background-color:rgb(240,240,240);">thoroughfarePostDirection</h3>
Postfix directional parsed from the '''thoroughfare''' parameter.
:Postfix directional parsed from the '''thoroughfare''' parameter.


'''US Term:''' Post Direction
:'''US Term:''' Post Direction




<h3 style="background-color:rgb(240,240,240);">thoroughfarePreDirection</h3>
<h3 style="background-color:rgb(240,240,240);">thoroughfarePreDirection</h3>
Prefix directional parsed from the '''thoroughfare''' parameter.
:Prefix directional parsed from the '''thoroughfare''' parameter.


'''US Term:''' Pre Direction
:'''US Term:''' Pre Direction




<h3 style="background-color:rgb(240,240,240);">thoroughfareTrailingType</h3>
<h3 style="background-color:rgb(240,240,240);">thoroughfareTrailingType</h3>
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.
: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
:'''US Term:''' Street Suffix




<h3 style="background-color:rgb(240,240,240);">thoroughfareTypeAttached</h3>
<h3 style="background-color:rgb(240,240,240);">thoroughfareTypeAttached</h3>
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.
: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==
==Parsed Dependent Thoroughfare Columns==
<h3 style="background-color:rgb(240,240,240);">dependentThoroughfare</h3>
<h3 style="background-color:rgb(240,240,240);">dependentThoroughfare</h3>
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.
: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
:'''US Term:''' Dependent Street




<h3 style="background-color:rgb(240,240,240);">dependentThoroughfareLeadingType</h3>
<h3 style="background-color:rgb(240,240,240);">dependentThoroughfareLeadingType</h3>
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."
: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."




<h3 style="background-color:rgb(240,240,240);">dependentThoroughfareName</h3>
<h3 style="background-color:rgb(240,240,240);">dependentThoroughfareName</h3>
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."
: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."




<h3 style="background-color:rgb(240,240,240);">dependentThoroughfarePostDirection</h3>
<h3 style="background-color:rgb(240,240,240);">dependentThoroughfarePostDirection</h3>
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."
: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."




<h3 style="background-color:rgb(240,240,240);">dependentThoroughfarePreDirection</h3>
<h3 style="background-color:rgb(240,240,240);">dependentThoroughfarePreDirection</h3>
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."
: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."




<h3 style="background-color:rgb(240,240,240);">dependentThoroughfareTrailingType</h3>
<h3 style="background-color:rgb(240,240,240);">dependentThoroughfareTrailingType</h3>
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."
: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."




<h3 style="background-color:rgb(240,240,240);">dependentThoroughfareTypeAttached</h3>
<h3 style="background-color:rgb(240,240,240);">dependentThoroughfareTypeAttached</h3>
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.
: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==
==Parsed Postal Facility Columns==
<h3 style="background-color:rgb(240,240,240);">postBox</h3>
<h3 style="background-color:rgb(240,240,240);">postBox</h3>
Post box information for a particular delivery point.
:Post box information for a particular delivery point.




<h3 style="background-color:rgb(240,240,240);">postalCode</h3>
<h3 style="background-color:rgb(240,240,240);">postalCode</h3>
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.
: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
:'''US Term:''' Zip Code




<h3 style="background-color:rgb(240,240,240);">personalID</h3>
<h3 style="background-color:rgb(240,240,240);">personalID</h3>
Used by certain Post Offices to identify a recipient for a package.
:Used by certain Post Offices to identify a recipient for a package.




Line 249: Line 249:
==Parsed Regional Columns==
==Parsed Regional Columns==
<h3 style="background-color:rgb(240,240,240);">administrativeArea</h3>
<h3 style="background-color:rgb(240,240,240);">administrativeArea</h3>
This is a common geographic area unit for larger countries. Often referred to as State or Province.
:This is a common geographic area unit for larger countries. Often referred to as State or Province.


'''US Term:''' State
:'''US Term:''' State




<h3 style="background-color:rgb(240,240,240);">countyName</h3>
<h3 style="background-color:rgb(240,240,240);">countyName</h3>
'''US Only'''. Sub Administrative Area. Smallest geographic data element.
:'''US Only'''. Sub Administrative Area. Smallest geographic data element.




<h3 style="background-color:rgb(240,240,240);">dependentLocality</h3>
<h3 style="background-color:rgb(240,240,240);">dependentLocality</h3>
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.
: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
:'''US Term:''' Urbanization




<h3 style="background-color:rgb(240,240,240);">doubleDependentLocality</h3>
<h3 style="background-color:rgb(240,240,240);">doubleDependentLocality</h3>
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.
: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.




<h3 style="background-color:rgb(240,240,240);">locality</h3>
<h3 style="background-color:rgb(240,240,240);">locality</h3>
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.
: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
:'''US Term:''' City




<h3 style="background-color:rgb(240,240,240);">subAdministrativeArea</h3>
<h3 style="background-color:rgb(240,240,240);">subAdministrativeArea</h3>
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.  
: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
:'''US Term:''' County




<h3 style="background-color:rgb(240,240,240);">subNationalArea</h3>
<h3 style="background-color:rgb(240,240,240);">subNationalArea</h3>
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.
: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.




==Extra Output Address Parameters==
==Extra Output Address Parameters==
====US Address Type Codes====
====US Address Type Codes====
Please see the [[Result Code Details#Global Address Object|Global Address Object Result Codes]] for a list of these codes.
:Please see the [[Result Code Details#Global Address Object|Global Address Object Result Codes]] for a list of these codes.
 


====Canadian Address Type Codes====
====Canadian Address Type Codes====
Please see the [[Result Code Details#Global Address Object|Global Address Object Result Codes]] for a list of these codes.
:Please see the [[Result Code Details#Global Address Object|Global Address Object Result Codes]] for a list of these codes.




<h3 style="background-color:rgb(240,240,240);">latitude</h3>
<h3 style="background-color:rgb(240,240,240);">latitude</h3>
North-south geographic coordinate for a particular delivery point.
:North-south geographic coordinate for a particular delivery point.




<h3 style="background-color:rgb(240,240,240);">longitude</h3>
<h3 style="background-color:rgb(240,240,240);">longitude</h3>
East-west geographic coordinate for a particular delivery point.
:East-west geographic coordinate for a particular delivery point.




Line 306: Line 305:


<h3 style="background-color:rgb(240,240,240);">countryName</h3>
<h3 style="background-color:rgb(240,240,240);">countryName</h3>
Full country name. Can be a nickname.
:Full country name. Can be a nickname.




<h3 style="background-color:rgb(240,240,240);">iso2Code</h3>
<h3 style="background-color:rgb(240,240,240);">iso2Code</h3>
ISO 3166 2-character country code.
:ISO 3166 2-character country code.


For example:
:For example:


{| class="alternate01"
:{| class="alternate01"
!Country !! Code
!Country !! Code
|-
|-
Line 326: Line 325:


<h3 style="background-color:rgb(240,240,240);">iso3Code</h3>
<h3 style="background-color:rgb(240,240,240);">iso3Code</h3>
ISO 3166 3-character country code.
:ISO 3166 3-character country code.


For example:
:For example:


{| class="alternate01"
:{| class="alternate01"
!Country !! Code
!Country !! Code
|-
|-
Line 342: Line 341:


<h3 style="background-color:rgb(240,240,240);">isoCountryNumber</h3>
<h3 style="background-color:rgb(240,240,240);">isoCountryNumber</h3>
ISO 3166 3-digit numeric country code.
:ISO 3166 3-digit numeric country code.


For example:
:For example:


{| class="alternate01"
:{| class="alternate01"
!Country !! Code
!Country !! Code
|-
|-
Line 358: Line 357:


<h3 style="background-color:rgb(240,240,240);">formalCountryName</h3>
<h3 style="background-color:rgb(240,240,240);">formalCountryName</h3>
Official Name for the country.
:Official Name for the country.




[[Category:Global Address Object]]
[[Category:Global Address Object]]
[[Category:Reference]]
[[Category:Reference]]

Revision as of 00:44, 21 September 2017

← 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




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.


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.


Output Address Parameters

organization

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


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 dependent locality. Does not include area information like locality, administrative area, and postal code.


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.


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.


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.


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.


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


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.


Extra Output Address Parameters

US Address Type Codes

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

Canadian Address Type Codes

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


latitude

North-south geographic coordinate for a particular delivery point.


longitude

East-west geographic coordinate for a particular delivery point.


Extra Output Country Parameters

countryCode


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.
Retrieved from "http://wiki.melissadata.com/index.php?title=Global_Address_Object:Output_Parameters&oldid=13316"