Global Address Object:Parameters: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
← Older edit
No edit summary
No edit summary
 
(9 intermediate revisions by the same user not shown)
Line 11: Line 11:
! style="color:black;"|[[Global Address Object:Introduction|Introduction]]
! style="color:black;"|[[Global Address Object:Introduction|Introduction]]
|-
|-
|[[Global Address Object:Platforms and Functions|Platforms and Functions]]
|[[Global Address Object:Platforms and Methods|Platforms and Methods]]
|-
|-
|[[Global Address Object:Licensing|Licensing]]
|[[Global Address Object:Licensing|Licensing]]
Line 31: Line 31:
{| class="mw-collapsible mw-collapsed" style="width:100%;"
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
|- align="left"
! style="color:black;"|[[Global Address Object:Functions|Functions]]
! style="color:black;"|[[Global Address Object:Methods|Methods]]
|-
|-
|[[Global Address Object:Setup Functions|Setup Functions]]
|[[Global Address Object:Setup Methods|Setup Methods]]
|-
|-
|[[Global Address Object:Input Methods|Input Methods]]
|[[Global Address Object:Input Methods|Input Methods]]
Line 42: Line 42:
|}
|}
|-
|-
|
|[[Global Address Object:Parameters|Parameters]]
{| class="mw-collapsible" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Address Object:Parameters|Parameters]]
|-
|[[Global Address Object:Processing Configuration Parameters|Processing Configuration Parameters]]
|-
|[[Global Address Object:Input Address Data Parameters|Input Address Data Parameters]]
|-
|[[Global Address Object:Output Address Data Parameters|Output Address Data Parameters]]
|}
|-
|-
|
|
Line 59: Line 49:
! style="color:black;"|[[Global Address Object:Result Codes|Result Codes]]
! style="color:black;"|[[Global Address Object:Result Codes|Result Codes]]
|-
|-
|[[Returned Result Codes#Global Address Object|Returned Result Codes]]
|[[Returned Result Codes:APIs#Global Address Object|Returned Result Codes]]
|-
|-
|[[Global Address Object:Other Codes|Other Codes]]
|[[Global Address Object:Other Codes|Other Codes]]
Line 68: Line 58:
{{CustomTOC}}
{{CustomTOC}}


The values listed in this section are grouped by function: Processing, Input, and Result output. Though they are listed in mixed case, the parameters are not case sensitive.
The values listed in this section are grouped by input and output. Though they are listed in mixed case, the parameters are not case sensitive.
 
==Input Parameters==
All of the following inputs can be set using SetInputParameter and can also be output using GetOutputParameter.
===Processing Configuration Parameters===
====countryOfOrigin====
The country from which the input file originated from.
 
====inputFormattedAddressSeparator====
This parameter collates all address lines into a single string with the defined '''lineSeparator''' as a delimiter.
 
 
===Input Address Parameters===
====inputOrganization====
'''''Business''''' or '''''Company'''''.
 
====inputAddressLine1====
Address lines should include, at minimum, the delivery address. It can also contain the full address if you do not have the area information (locality, administrative area, postal code) parsed into their individual fields.
 
====inputAddressLine2====
====inputAddressLine3====
====inputAddressLine4====
====inputAddressLine5====
====inputAddressLine6====
====inputAddressLine7====
====inputAddressLine8====
 
====inputDoubleDependentLocality====
Smallest population center data element.
 
====inputDependentLocality====
'''''Urbanization'''''. Smaller population center data element. Dependent on Locality.
 
====inputLocality====
'''''City'''''. Most common population center data element.
 
====inputSubAdministrativeArea====
'''''County'''''. Smallest geographic data element.
 
====inputAdministrativeArea====
'''''State'''''. Most common geographic data element.
 
====inputSubNationalArea====
Arbitrary administrative region below that of the sovereign state.
 
====inputPostalCode====
'''''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.
 
====inputCountry====
The country of the address.
 
 
==Output Parameters==
===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 [[Global Address Object:Setup Methods#SetLicenseString|SetLicenseString]].
 
====remnants====
Any elements parsed from the input address data which could not be processed or were not relevant to the address processing are returned in the remnant parameter.
 
====resultCodes====
Result code(s) generated for the address. Reference |[[Returned Result Codes:APIs#Global Address Object|Returned Result Codes]] for more information.
 
====timezone====
Name of the timezone of the address.
 
====utc====
Coordinated Universal Time (Universal Time Coordinated). Code that designates the UTC offset for the given time zone of the address. This does not indicate differences due to daylight savings time.
 
 
===Output Address Parameters===
====organization====
'''''Business''''' or '''''Company'''''
 
====addressLine1====
Adress Lines 1-8 will contain the full output address in the preferred format for that country.
====addressLine2====
====addressLine3====
====addressLine4====
====addressLine5====
====addressLine6====
====addressLine7====
====addressLine8====
 
 
===Parsed Sub-Premises Parameters===
====building====
Descriptive name identifying an individual location.
 
====subBuilding====
Descriptive name identifying an individual location. More specific than building.
 
====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====
'''''Suite'''''. Alphanumeric code identifying an individual location. More specific than premises.
 
====subPremisesNumber====
'''''Suite Number'''''. Sub premises number indicator within premises field. Parsed from the '''subPremises''' parameter.
 
====subPremisesType====
'''''Suite Name'''''. Sub premises type indicator within premises field. Parsed from the '''subPremises''' parameter.
 
====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====
'''''Street Number'''''.
 
====premisesNumber====
Alphanumeric indicator within premises field. Parsed from the '''premises''' parameter.
 
====premisesType====
Leading premise type indicator within premises field. Parsed from the '''premises''' parameter.
 
====thoroughfare====
'''''Street'''''. Most common street or block data element.
 
====thoroughfareLeadingType====
Leading thoroughfare type indicator parsed from the '''thoroughfare''' parameter.
 
====thoroughfareName====
'''''Street Name'''''. Name indicator parsed from the '''thoroughfare''' parameter.
 
====thoroughfarePostDirection====
'''''Street Post Direction'''''. Postfix directional parsed from the '''thoroughfare''' parameter.
 
====thoroughfarePreDirection====
'''''Street PreDirection'''''. Prefix directional parsed from the '''thoroughfare''' parameter.
 
====thoroughfareTrailingType====
'''''Street Suffix'''''. Trailing thoroughfare type indicator parsed from the '''thoroughfare''' parameter.
 
====thoroughfareTypeAttached====
Thoroughfare type connected to the thoroughfare name without a space. This is common in Germany. For example, "Berlinerstr." "str." stands for strasse and is the thoroughfare type attached, while "Berliner" is the thoroughfare name.
 
 
===Parsed Dependent Thoroughfare Columns===
====dependentThoroughfare====
'''''Dependent street''''' or block data element. This is used when there are more than one thoroughfares with the same name in one locality. An adjoining thoroughfare is used to uniquely identify the target thoroughfare.
 
====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====
'''''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.
 
====personalID====
Used by certain Post Offices to identify a recipient for a package.
 
====postOfficeLocation====


==[[Global Address Object:Processing Configuration Parameters|Processing Configuration Parameters]]==
*requestedOutputType
*requestingCountry
*AlphabetOverride
*lineSeparator
*Case
*Fielding


===Parsed Regional Columns===
====administrativeArea====
'''''State'''''. Most common geographic data element.


==[[Global Address Object:Input Address Data Parameters|Input Address Data Parameters]]==
====countyName====
===[[Global Address Object:Input Address Data Parameters#General|General]]===
'''US Only'''. '''''Sub Administrative Area'''''. Smallest geographic data element.
*inputXML


===[[Global Address Object:Input Address Data Parameters#Organization|Organization]]===
====dependentLocality====
*inputOrganization
'''''Urbanization'''''. Smaller population center data element. Dependent on Locality.


===[[Global Address Object:Input Address Data Parameters#Address Lines|Address Lines]]===
====doubleDependentLocality====
*inputAddressLine1
Smallest population center data element.
*inputAddressLine2
*inputAddressLine3
*inputAddressLine4
*inputAddressLine5
*inputAddressLine6
*inputAddressLine7
*inputAddressLine8
*inputFormattedAddress


===[[Global Address Object:Input Address Data Parameters#Locality Levels|Locality Levels]]===
====locality====
*inputDoubleDependentLocality
'''''City'''''. Most common population center data element.
*inputDependentLocality
 
*inputLocality
====subAdministrativeArea====
*inputPostalCode
'''''County'''''. Smallest geographic data element.
 
====subNationalArea====
Arbitrary administrative region below that of the sovereign state.
 
 
===Extra Output Address Parameters===
====US Address Type Codes====
{|class="alternate01 sortable" cellspacing="0"
!Code
!Description
|-
|A
|Alias
|-
|F
|Firm or Company
|-
|G
|General Delivery
|-
|H
|Highrise or Business Complex
|-
|P
|PO Box
|-
|R
|Rural Route
|-
|S
|Street or Residential
|}
 
====Canadian Address Type Codes====
{|class="alternate01 sortable" cellspacing="0"
!Code
!Description
|-
|1
|Street
|-
|2
|Street Served by Route and GD
|-
|3
|Lock Box
|-
|4
|Route Service
|-
|5
|General Delivery
|-
|B
|LVR Street
|-
|C
|Government Street
|-
|D
|LVR Lock Box
|-
|E
|Government Lock Box
|-
|L
|LVR General Delivery
|-
|K
|Building
|}


===[[Global Address Object:Input Address Data Parameters#Administrative Area and Higher|Administrative Area and Higher]]===
====formattedAddress====
*inputSubAdministrativeArea
Mailing address. The full mailing address in the preferred format for the country of the address.
*inputAdministrativeArea
*inputSubNationalArea
*inputCountry
*InputUnreliableCountry
*inputCountryCode
*inputCountryNumber


===[[Global Address Object:Input Address Data Parameters#Address Thoroughfare and Premise|Address Thoroughfare and Premise]]===
====latitude====
*inputpostBox
North-south geographic coordinate for a particular delivery point.
*premiseNumber
*premiseType
*subPremiseNumber
*subPremiseType
*thoroughfareLeadingType
*thoroughfare
*thoroughfarePostDirection
*thoroughfarePreDirection
*thoroughfareTrailingType
*thoroughfareTrailingTypeAttached


====longitude====
East-west geographic coordinate for a particular delivery point.


==[[Global Address Object:Output Address Data Parameters|Output Address Data Parameters]]==
===[[Global Address Object:Output Address Data Parameters#Organization|Organization]]===
*outputOrganization


===[[Global Address Object:Output Address Data Parameters#Address Lines|Address Lines]]===
===Extra Output Country Parameters===
*outputAddressLine1
====countryCode====
*outputAddressLine2
====countryName====
*outputAddressLine3
Full country name. Can be a nickname.
*outputAddressLine4
*outputAddressLine5
*outputAddressLine6
*outputAddressLine7
*outputAddressLine8
*outputFormattedAddress


===[[Global Address Object:Output Address Data Parameters#Locality Levels|Locality Levels]]===
====iso2Code====
*outputDoubleDependentLocality
ISO 3166 2-character country code.
*outputDependentLocality
*outputLocality
*outputPostalCode


===[[Global Address Object:Output Address Data Parameters#Administrative Area and Higher|Administrative Area and Higher]]===
====iso3Code====
*outputSubAdministrativeArea
ISO 3166 3-character country code.
*outputAdministrativeArea
*outputSubNationalArea
*outputCountry
*outputCountryCode
*outputCountryNumber


===[[Global Address Object:Output Address Data Parameters#Address Thoroughfare and Premise|Address Thoroughfare and Premise]]===
====isoCountryNumber====
*outputPostBox
ISO 3166 3-digit numeric country code.
*outputPremiseNumber
*outputPremiseType
*outputsubpremiseNumber
*outputsubpremiseType
*outputThoroughfareLeadingType
*outputThoroughfare
*outputThoroughfareName
*outputPremise
*outputThoroughfarePostDirection
*outputThoroughfarePreDirection
*outputThoroughfareTrailingType
*outputThoroughfareTrailingTypeAttached


===[[Global Address Object:Output Address Data Parameters#Other Output Parameters|Other Output Parameters]]===
====formalCountryName====
*remnant
Official Name for the country.
*outputXML
*outputDST
*outputTimeZone
*outputUTC
*outputLanguage
*outputAlphabet
*resultCode
*detailCode




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

Latest revision as of 00:28, 9 March 2019

← Global Address Object Reference

Global Address Object Navigation
Introduction
Platforms and Methods
Licensing
Result Code Use
Interface
Address Handling
Interface Use
Methods
Setup Methods
Input Methods
Processing Methods
Output Methods
Parameters
Result Codes
Returned Result Codes
Other Codes



The values listed in this section are grouped by input and output. Though they are listed in mixed case, the parameters are not case sensitive.

Input Parameters

All of the following inputs can be set using SetInputParameter and can also be output using GetOutputParameter.

Processing Configuration Parameters

countryOfOrigin

The country from which the input file originated from.

inputFormattedAddressSeparator

This parameter collates all address lines into a single string with the defined lineSeparator as a delimiter.


Input Address Parameters

inputOrganization

Business or Company.

inputAddressLine1

Address lines should include, at minimum, the delivery address. It can also contain the full address if you do not have the area information (locality, administrative area, postal code) parsed into their individual fields.

inputAddressLine2

inputAddressLine3

inputAddressLine4

inputAddressLine5

inputAddressLine6

inputAddressLine7

inputAddressLine8

inputDoubleDependentLocality

Smallest population center data element.

inputDependentLocality

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

inputLocality

City. Most common population center data element.

inputSubAdministrativeArea

County. Smallest geographic data element.

inputAdministrativeArea

State. Most common geographic data element.

inputSubNationalArea

Arbitrary administrative region below that of the sovereign state.

inputPostalCode

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.

inputCountry

The country of the address.


Output Parameters

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 |Returned Result Codes for more information.

timezone

Name of the timezone of the address.

utc

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


Output Address Parameters

organization

Business or Company

addressLine1

Adress Lines 1-8 will contain the full output address in the preferred format for that country.

addressLine2

addressLine3

addressLine4

addressLine5

addressLine6

addressLine7

addressLine8

Parsed Sub-Premises Parameters

building

Descriptive name identifying an individual location.

subBuilding

Descriptive name identifying an individual location. More specific than building.

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

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

subPremisesNumber

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

subPremisesType

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

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

Street Number.

premisesNumber

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

premisesType

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

thoroughfare

Street. Most common street or block data element.

thoroughfareLeadingType

Leading thoroughfare type indicator parsed from the thoroughfare parameter.

thoroughfareName

Street Name. Name indicator parsed from the thoroughfare parameter.

thoroughfarePostDirection

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

thoroughfarePreDirection

Street PreDirection. Prefix directional parsed from the thoroughfare parameter.

thoroughfareTrailingType

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

thoroughfareTypeAttached

Thoroughfare type connected to the thoroughfare name without a space. This is common in Germany. For example, "Berlinerstr." "str." stands for strasse and is the thoroughfare type attached, while "Berliner" is the thoroughfare name.


Parsed Dependent Thoroughfare Columns

dependentThoroughfare

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

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

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.

personalID

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

postOfficeLocation

Parsed Regional Columns

administrativeArea

State. Most common geographic data element.

countyName

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

dependentLocality

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

doubleDependentLocality

Smallest population center data element.

locality

City. Most common population center data element.

subAdministrativeArea

County. Smallest geographic data element.

subNationalArea

Arbitrary administrative region below that of the sovereign state.


Extra Output Address Parameters

US Address Type Codes

Code Description
A Alias
F Firm or Company
G General Delivery
H Highrise or Business Complex
P PO Box
R Rural Route
S Street or Residential

Canadian Address Type Codes

Code Description
1 Street
2 Street Served by Route and GD
3 Lock Box
4 Route Service
5 General Delivery
B LVR Street
C Government Street
D LVR Lock Box
E Government Lock Box
L LVR General Delivery
K Building

formattedAddress

Mailing address. The full mailing address in the preferred format for the country of the address.

latitude

North-south geographic coordinate for a particular delivery point.

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.

iso3Code

ISO 3166 3-character country code.

isoCountryNumber

ISO 3166 3-digit numeric country code.

formalCountryName

Official Name for the country.

Retrieved from "http://wiki.melissadata.com/index.php?title=Global_Address_Object:Parameters&oldid=16131"