Global Address Object:Output Parameters: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
← Older edit
No edit summary
No edit summary
 
(27 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Global Address Object:Reference|← Global Address Object Reference]]
{{GlobalAddressObjectNav
|ParametersCollapse=
}}


{| class="mw-collapsible" cellspacing="2" style="background-color:#f9f9f9; border:1px solid #aaaaaa; font-size:9pt; color:#0645ad; padding:8px 8px;"
{{CustomTOC}}
! style="text-align:left; color:black; border-bottom:1px solid #aaaaaa;"|'''Global Address Object Navigation'''
 
|-  
 
| style="padding-right:220px;"|
Though they are listed in mixed case, the parameters are not case sensitive.
 
==Output Detail Parameters==
<h3 class="h3grey">buildNumber</h3>
:Build number of the Global Address Object API.
 
 
<h3 class="h3grey">databaseDate</h3>
:Release date of the database.
 
 
<h3 class="h3grey">databaseExpirationDate</h3>
:Expiration date of the database.
 
 
<h3 class="h3grey">dst</h3>
:A true/false value delineating if the given address is in a time zone that supports Daylight Savings Time (DST).
 
 
<h3 class="h3grey">initializeErrorString</h3>
:An error string detailing any failure or error in initializing the reference data file(s) and/or Global Address Object.
 
 
<h3 class="h3grey">licenseStringExpirationDate</h3>
:Expiration date for the License Key set with [[Global Address Object:Setup Methods#SetLicenseString|SetLicenseString]].
 
 
<h3 class="h3grey">remnants</h3>
: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.
 
 
<h3 class="h3grey">resultCodes</h3>
:Result code(s) generated for the address.
 
:Reference [[Result Code Details#Global Address Object|Global Address Object Result Codes]] for more information.
 
 
<h3 class="h3grey">timezone</h3>
:Name of the timezone of the address.
 
 
<h3 class="h3grey">utc</h3>
: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==
<h3 class="h3grey">organization</h3>
: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
 
 
<h3 class="h3grey">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.
 
 
<h3 class="h3grey">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.
 
 
<h3 class="h3grey">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.
 
 
<h3 class="h3grey">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.
 
 
<h3 class="h3grey">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.
 
 
<h3 class="h3grey">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.
 
 
<h3 class="h3grey">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.
 
 
<h3 class="h3grey">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.
 
 
<h3 class="h3grey">deliveryLine</h3>
: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.
 
 
<h3 class="h3grey">localityLine</h3>
: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.
 
 
<h3 class="h3grey">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.
 
 
<h3 class="h3grey">DeliveryPointSuffix</h3>
:This is a country dependent field. This field returns an identifier that represents a suffix code usually tied to a delivery point.
 
:;US
::This returns the 2 digit delivery point assigned by the USPS to an DPV validated address.
 
:;GB
::This is a 2 character (first is numerical, 2nd character is alphabetic) that is assigned by Royal Mail. When added to the postal code, this allows each live delivery point to be uniquely identified.
 
 
<h3 class="h3grey">AddressTypeCode</h3>
:This is a country dependent field. This field returns a code to identify the type of address that the input is identified as.
 
:;US
::{| class="alternate01"
!Code !! Description
|-
|-
|
|A||Alias
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Address Object:Introduction|Introduction]]
|-
|-
|[[Global Address Object:Platforms and Methods|Platforms and Methods]]
|F||Firm or Company
|-
|-
|[[Global Address Object:Licensing|Licensing]]
|G||General Delivery
|-
|-
|[[Global Address Object:Result Code Use|Result Code Use]]
|H||Highrise or Business Complex
|}
|-
|-
|
|P||PO Box
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Address Object:Interface|Interface]]
|-
|-
|[[Global Address Object:Address Handling|Address Handling]]
|R||Rural Route
|-
|-
|[[Global Address Object:Interface Use|Interface Use]]
|S||Street or Residential
|}
|}
:;CA
::{| class="alternate01"
!Code !! Description
|-
|-
|
|1||Street
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Address Object:Methods|Methods]]
|-
|-
|[[Global Address Object:Setup Methods|Setup Methods]]
|2||Street Served by Route and GD
|-
|-
|[[Global Address Object:Input Methods|Input Methods]]
|3||Lock Box
|-
|-
|[[Global Address Object:Processing Methods|Processing Methods]]
|4||Route Service
|-
|-
|[[Global Address Object:Output Methods|Output Methods]]
|5||General Delivery
|}
|-
|-
|
|B||LVR Street
{| class="mw-collapsible" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Address Object:Parameters|Parameters]]
|-
|-
|[[Global Address Object:Input Parameters|Input Parameters]]
|C||Government Street
|-
|-
|[[Global Address Object:Output Parameters|Output Parameters]]
|D||LVR Lock Box
|}
|-
|-
|
|E||Government Lock Box
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Address Object:Result Codes|Result Codes]]
|-
|-
|[[Returned Result Codes:APIs#Global Address Object|Returned Result Codes]]
|L||LVR General Delivery
|-
|-
|[[Global Address Object:Other Codes|Other Codes]]
|K||Building
|}
|}
:;GB
::{| class="alternate01"
!Code !! Description
|-
|L||This address is identified as having a large user postal code. This is due to the large volume of mail received at that address, or because a PO Box or Selectapost service has been set up.
|-
|S||This address is identified as having a smaller user postal code. This means this postal code will have usually around 15 delivery points but never more than 100.
|}
|}




<div class="toclimit-2">{{CustomTOC}}</div>
<h3 class="h3grey">AddressKey</h3>
:This is a country dependent field. This field returns an identifier that is used in the country by the official postal agency or another well-recognized agency or standard.
 
:;US:This returns a 11 digit code representing the combination of the zip code, the plus4, and the delivery point. This is a fairly good representation of a unique US address and often used as the core of postal barcode. However, this code is not guaranteed to be unique to an individual address, please use the MelissaAddressKey instead for that purpose. It is possible that this field is empty or not 11 digits if the address is a Non-USPS address.
 
:;GB
::This field returns the UDPRN, which stands for Unique Delivery Point Reference Number. It is a 8 character code that is assigned and maintained by Royal Mail to each delivery point address.
 


<h3 class="h3grey">MelissaAddressKey</h3>
:This is a globally unique and persistent key for the location, even if parts of the address change. When an address is fully validated this field returns a 10-digit proprietary key for the address. Currently available for US, AT, AU, BE, BM, BR, CA, CH, DE, DK, ES, FR, GB, IE, IS, IT, KR, LT, MC, NC, NL, NO, PT, SG, SI, and TR with many more countries planned for the future.
:With AddressKey (US and Canada only), if an address zip code changes, the AddressKey would also change. Melissa Address Key (MAK) is independent and will not change. This makes MAK a good way to permanently identify and locate addresses. Once you have a MAK it can be used as an input in most Melissa services and thus is a good tool for deduping.
<h3 class="h3grey">MelissaAddressKeyBase</h3>
:Every full address has its own Melissa Address Key (MAK).  If that address is a suites or apartment, we will also return a Melissa Address Key Base (BaseMAK) that corresponds to the overall building. This provides a link between all the individual MAK addresses that belong to the same building. This field also returns a 10-digit proprietary key. Note, if we can validate the address to the building but not the suite, we can return just the BaseMAK.
==Parsed Sub-Premises Parameters==
<h3 class="h3grey">building</h3>
:Descriptive name identifying an individual location. This is a string value that is the parsed Building element from the output.


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


==Output Detail Parameters==
<h3 class="h3grey">subBuilding</h3>
===buildNumber===
:Descriptive name identifying an individual location. More specific than building. This is a string value that is the parsed '''premisesType''' parameter from the output.
Build number of the Global Address Object API.


===databaseDate===
Release date of the database.


===databaseExpirationDate===
<h3 class="h3grey">subBuildingNumber</h3>
Expiration date of the database.
:Sub building number indicator within building field. Parsed from the '''subBuilding''' parameter.


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


===initializeErrorString===
<h3 class="h3grey">subBuildingType</h3>
An error string detailing any failure or error in initializing the reference data file(s) and/or Global Address Object.
:Sub building type indicator within building field. Parsed from the '''subBuilding''' parameter.


===licensedCountries===
A list of countries licensed for the license string set with [[Global Address Object:Setup Methods#SetLicenseString|SetLicenseString]].


===licenseStringExpirationDate===
<h3 class="h3grey">subPremises</h3>
Expiration date for the license string set with [[Global Address Object:Setup Methods#SetLicenseString|SetLicenseString]].
:Alphanumeric code identifying an individual location. More specific than premises.


===remnants===
:'''US Term:''' Suite
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:APIs#Global Address Object|Returned Result Codes]] for more information.


===timezone===
<h3 class="h3grey">subPremisesNumber</h3>
Name of the timezone of the address.
:Sub premises number indicator within premises field. Parsed from the '''subPremises''' parameter.


===utc===
:'''US Term:''' Suite Number
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==
<h3 class="h3grey">subPremisesType</h3>
===organization===
:Sub premises type indicator within premises field. Parsed from the '''subPremises''' parameter.
'''''Business''''' or '''''Company'''''


===addressLine1===
:'''US Term:''' Suite Name
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.


<h3 class="h3grey">subPremisesLevel</h3>
:Alphanumeric code identifying an individual location. More specific than sub premises.


==Parsed Sub-Premises Parameters==
===building===
Descriptive name identifying an individual location.


===subPremises===
<h3 class="h3grey">subPremisesLevelNumber</h3>
'''''Suite'''''. Alphanumeric code identifying an individual location.
:Sub premises level number indicator within premises field. Parsed from the '''subPremisesLevel''' parameter.


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


===subPremisesType===
<h3 class="h3grey">subPremisesLevelType</h3>
'''''Suite Name'''''. Sub premises type indicator within premises field. Parsed from the '''subPremises''' parameter.
:Sub premises level type indicator within premises field. Parsed from the '''subPremisesLevel''' parameter.




==Parsed Thoroughfare Parameters==
==Parsed Thoroughfare Parameters==
===premises===
<h3 class="h3grey">premises</h3>
'''''Street Number'''''.
:'''US Term:''' Street Number


===premisesNumber===
Alphanumeric indicator within premises field. Parsed from the '''premises''' parameter.


===premisesType===
<h3 class="h3grey">premisesNumber</h3>
Leading premise type indicator within premises field. Parsed from the '''premises''' parameter.
:Alphanumeric indicator within premises field. Parsed from the '''premises''' parameter.


===thoroughfare===
:'''US Term:''' House Number
'''''Street'''''. Most common street or block data element.


===thoroughfareLeadingType===
Leading thoroughfare type indicator parsed from the '''thoroughfare''' parameter.


===thoroughfareName===
<h3 class="h3grey">premisesType</h3>
'''''Street Name'''''. Name indicator parsed from the '''thoroughfare''' parameter.
:Leading premise type indicator within premises field. Parsed from the '''premises''' parameter.


===thoroughfarePostDirection===
'''''Street Post Direction'''''. Postfix directional parsed from the '''thoroughfare''' parameter.


===thoroughfarePreDirection===
<h3 class="h3grey">thoroughfare</h3>
'''''Street PreDirection'''''. Prefix directional parsed from the '''thoroughfare''' parameter.
: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.


===thoroughfareTrailingType===
:'''US Term:''' Street
'''''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.
<h3 class="h3grey">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.
 
:'''US Term:''' Not used in the US
 
 
<h3 class="h3grey">thoroughfareName</h3>
:Name indicator parsed from the '''thoroughfare''' parameter.
 
:'''US Term:''' Street Name
 
 
<h3 class="h3grey">thoroughfarePostDirection</h3>
:Postfix directional parsed from the '''thoroughfare''' parameter.
 
:'''US Term:''' Post Direction
 
 
<h3 class="h3grey">thoroughfarePreDirection</h3>
:Prefix directional parsed from the '''thoroughfare''' parameter.
 
:'''US Term:''' Pre Direction
 
 
<h3 class="h3grey">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.
 
:'''US Term:''' Street Suffix
 
 
<h3 class="h3grey">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.




==Parsed Dependent Thoroughfare Columns==
==Parsed Dependent Thoroughfare Columns==
===dependentThoroughfare===
<h3 class="h3grey">dependentThoroughfare</h3>
'''''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.
: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
 
 
<h3 class="h3grey">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."
 
 
<h3 class="h3grey">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."
 


===dependentThoroughfareConjunction===
<h3 class="h3grey">dependentThoroughfarePostDirection</h3>
===dependentThoroughfareLeadingType===
: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."
Leading thoroughfare type indicator parsed from the '''dependentThoroughfare''' parameter.


===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===
<h3 class="h3grey">dependentThoroughfarePreDirection</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 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."


===dependentThoroughfarePreDirection===


<h3 class="h3grey">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."


===dependentThoroughfareTrailingType===


<h3 class="h3grey">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.


===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==
==Parsed Postal Facility Columns==
===carrierRoute===
<h3 class="h3grey">postBox</h3>
'''US Only'''. A grouping of households served by an individual mail carrier within a five-digit zip code area.
:Post box information for a particular delivery point.
 
 
<h3 class="h3grey">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.
 
:'''US Term:''' Zip Code


===parsedDeliveryInstallation===
===parsedLockBox===
===parsedPrivateMailboxName===
===parsedPrivateMailboxNumber===
===parsedRouteService===
===postBox===
Post box information for a particular delivery point.


===postalCode===
<h3 class="h3grey">postOfficeLocation</h3>
'''''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==
==Parsed Regional Columns==
===administrativeArea===
<h3 class="h3grey">administrativeArea</h3>
'''''State'''''. Most common geographic data element.
:This is a common geographic area unit for larger countries. Often referred to as State or Province.
 
:'''US Term:''' State
 
 
<h3 class="h3grey">countyName</h3>
:'''US Only'''. Sub Administrative Area. Smallest geographic data element.


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


===congressionalDistrict===
<h3 class="h3grey">dependentLocality</h3>
'''US Only'''. Population-based. Congressional District of the address.
: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.


===countyFips===
:'''US Term:''' Urbanization
'''US Only'''. Six-digit Federal Information Processing Standard (FIPS) code for the county.


===countyName===
'''US Only'''. '''''Sub Administrative Area'''''. Smallest geographic data element.


===dependentLocality===
<h3 class="h3grey">doubleDependentLocality</h3>
'''''Urbanization'''''. Smaller population center data element. Dependent on 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.


===doubleDependentLocality===
Smallest population center data element.


===locality===
<h3 class="h3grey">locality</h3>
'''''City'''''. Most common population center data element.
: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.


===subAdministrativeArea===
:'''US Term:''' City
'''''County'''''. Smallest geographic data element.


===subNationalArea===
Arbitrary administrative region below that of the sovereign state.


===urbanization===
<h3 class="h3grey">subAdministrativeArea</h3>
'''US Only'''. '''''Dependent Locality'''''. Smaller population center data element. Dependent on Locality.
: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
 
 
<h3 class="h3grey">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.




==Extra Output Address Parameters==
==Extra Output Address Parameters==
===addressKey===
<h3 class="h3grey">latitude</h3>
Unique key generated for the address. Can be used by other Melissa Data products.
:North-south geographic coordinate for a particular delivery point.
 
 
<h3 class="h3grey">longitude</h3>
:East-west geographic coordinate for a particular delivery point.
 
 
==Extra Output Country Parameters==
<h3 class="h3grey">countryName</h3>
:Full country name. Can be a nickname.
 
 
<h3 class="h3grey">iso2Code</h3>
:ISO 3166 2-character country code.
 
:For example:
 
:{| class="alternate01"
!Country !! Code
|-
|United States||US
|-
|Canada||CA
|-
|Philippines||PH
|}
 
 
<h3 class="h3grey">iso3Code</h3>
:ISO 3166 3-character country code.
 
:For example:
 
:{| class="alternate01"
!Country !! Code
|-
|United States||USA
|-
|Canada||CAN
|-
|Philippines||PHL
|}
 
 
<h3 class="h3grey">isoCountryNumber</h3>
:ISO 3166 3-digit numeric country code.
 
:For example:
 
:{| class="alternate01"
!Country !! Code
|-
|United States||840
|-
|Canada||124
|-
|Philippines||608
|}
 
 
<h3 class="h3grey">CountrySubdivisionCode</h3>
:This field returns the ISO 3166-2 country sub-division code. This code is part of the ISO 3166 international standard to represent the relevant administrative divisions and dependent territories for a country. For most countries, this code is tied to the administrative area. Not all countries currently return this code but we are planning on adding more.
 
 
<h3 class="h3grey">formalCountryName</h3>
:Official Name for the country.
 
 
==US Only Output Parameters==
<h3 class="h3grey">USCityAbbreviation</h3>
:Get the abbreviated city name.
 
 
<h3 class="h3grey">USPlus4</h3>
:Get the plus4 by itself.
 
 
<h3 class="h3grey">USCarrierRoute</h3>
:Get the Carrier Route.
 
 
<h3 class="h3grey">USDeliveryPointCode</h3>
:Get the 2 digit delivery point code
 
 
<h3 class="h3grey">USDeliveryPointCheckDigit</h3>
:Get the 1 digit devliery point check digit
 
 
<h3 class="h3grey">USCongressionalDistrict</h3>
:Get the congressional district number of the address
 
 
<h3 class="h3grey">DeliveryIndicator</h3>
:This field returns a one character code that indicates if the address is a residence (R), business (B), or unknown (U). It is not available for all countries. Currently, it is available only for the US but more countries are planned for future inclusion.
 
 
<h3 class="h3grey">USCensusTract</h3>
:Census Tract value
 
 
<h3 class="h3grey">USCensusBlock</h3>
:Census Block value
 
 
<h3 class="h3grey">USBlockSuffix</h3>
:Census Block Suffix
 
 
<h3 class="h3grey">USCountyFips</h3>
:County FIPS number
 
 
<h3 class="h3grey">USCountyName</h3>
:County Name
 
 
<h3 class="h3grey">USPlaceCode</h3>
:Census Place Code
 
 
<h3 class="h3grey">USPlaceName</h3>
:Census Place Name


===addressTypeCode===
One-character code for the type of address coded.


===addressTypeString===
<h3 class="h3grey">USCBSACode</h3>
===deliveryline===
:Census CBSA Code
===formattedAddress===
===latitude===
Geographic coordinate for a particular delivery point.


===localityLine===
===longitude===
Geographic coordinate for a particular delivery point.


<h3 class="h3grey">USCBSATitle</h3>
:Census CBSA Title


==Extra Output Country Parameters==
===countryAbbreviation===
===countryCode===
===countryName===
Full country name.


===iso2Code===
<h3 class="h3grey">USCBSALevel</h3>
ISO 3166 2-character country code.
:Census CBSA Level
 
 
<h3 class="h3grey">USCBSADivisionCode</h3>
:Census CBSA Division Code
 
 
<h3 class="h3grey">USCBSADivisionTitle</h3>
:Census CBSA Division Title
 
 
<h3 class="h3grey">USCBSADivisionLevel</h3>
:Census CBSA Division Level
 
 
<h3 class="h3grey">USCensusKey</h3>
:Census Key value
 
 
<h3 class="h3grey">USCountySubdivisionCode</h3>
:Census County Subdivision Code
 
 
<h3 class="h3grey">USCountySubdivisionName</h3>
:Census County Subdivision Name
 
 
<h3 class="h3grey">USElementarySchoolDistrictCode</h3>
:Elementary School District Code
 
 
<h3 class="h3grey">USElementarySchoolDistrictName</h3>
:Elementary School District Name
 
 
<h3 class="h3grey">USSecondarySchoolDistrictCode</h3>
:Secondary School District Code
 
 
<h3 class="h3grey">USSecondarySchoolDistrictName</h3>
:Secondary School District Name
 
 
<h3 class="h3grey">USUnifiedSchoolDistrictCode</h3>
:Secondary School District Code
 
 
<h3 class="h3grey">USUnifiedSchoolDistrictName</h3>
:Secondary School District Name
 
 
<h3 class="h3grey">USStateDistrictLower</h3>
:State Lower Congressional District Number
 
 
<h3 class="h3grey">USStateDistrictUpper</h3>
:State Upper Congressional District Number
 


===iso3Code===
<h3 class="h3grey">USZipType</h3>
ISO 3166 3-character country code.
:Returns the Zip Type for US


===isoCountryNumber===
:{| class="alternate01"
ISO 3166 3-digit numeric country code.
!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
|}




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

Latest revision as of 16:20, 1 February 2024

← 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

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.


DeliveryPointSuffix

This is a country dependent field. This field returns an identifier that represents a suffix code usually tied to a delivery point.
US
This returns the 2 digit delivery point assigned by the USPS to an DPV validated address.
GB
This is a 2 character (first is numerical, 2nd character is alphabetic) that is assigned by Royal Mail. When added to the postal code, this allows each live delivery point to be uniquely identified.


AddressTypeCode

This is a country dependent field. This field returns a code to identify the type of address that the input is identified as.
US
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
CA
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
GB
Code Description
L This address is identified as having a large user postal code. This is due to the large volume of mail received at that address, or because a PO Box or Selectapost service has been set up.
S This address is identified as having a smaller user postal code. This means this postal code will have usually around 15 delivery points but never more than 100.


AddressKey

This is a country dependent field. This field returns an identifier that is used in the country by the official postal agency or another well-recognized agency or standard.
US
This returns a 11 digit code representing the combination of the zip code, the plus4, and the delivery point. This is a fairly good representation of a unique US address and often used as the core of postal barcode. However, this code is not guaranteed to be unique to an individual address, please use the MelissaAddressKey instead for that purpose. It is possible that this field is empty or not 11 digits if the address is a Non-USPS address.
GB
This field returns the UDPRN, which stands for Unique Delivery Point Reference Number. It is a 8 character code that is assigned and maintained by Royal Mail to each delivery point address.


MelissaAddressKey

This is a globally unique and persistent key for the location, even if parts of the address change. When an address is fully validated this field returns a 10-digit proprietary key for the address. Currently available for US, AT, AU, BE, BM, BR, CA, CH, DE, DK, ES, FR, GB, IE, IS, IT, KR, LT, MC, NC, NL, NO, PT, SG, SI, and TR with many more countries planned for the future.
With AddressKey (US and Canada only), if an address zip code changes, the AddressKey would also change. Melissa Address Key (MAK) is independent and will not change. This makes MAK a good way to permanently identify and locate addresses. Once you have a MAK it can be used as an input in most Melissa services and thus is a good tool for deduping.


MelissaAddressKeyBase

Every full address has its own Melissa Address Key (MAK). If that address is a suites or apartment, we will also return a Melissa Address Key Base (BaseMAK) that corresponds to the overall building. This provides a link between all the individual MAK addresses that belong to the same building. This field also returns a 10-digit proprietary key. Note, if we can validate the address to the building but not the suite, we can return just the BaseMAK.


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


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

latitude

North-south geographic coordinate for a particular delivery point.


longitude

East-west geographic coordinate for a particular delivery point.


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


CountrySubdivisionCode

This field returns the ISO 3166-2 country sub-division code. This code is part of the ISO 3166 international standard to represent the relevant administrative divisions and dependent territories for a country. For most countries, this code is tied to the administrative area. Not all countries currently return this code but we are planning on adding more.


formalCountryName

Official Name for the country.


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

This field returns a one character code that indicates if the address is a residence (R), business (B), or unknown (U). It is not available for all countries. Currently, it is available only for the US but more countries are planned for future inclusion.


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