Difference between revisions of "Global Address Object:Parameters"

From Melissa Data Wiki
Jump to navigation Jump to search
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 47: Line 47:
! style="color:black;"|[[Global Address Object:Parameters|Parameters]]
! style="color:black;"|[[Global Address Object:Parameters|Parameters]]
|-
|-
|[[Global Address Object:Processing Configuration Parameters|Processing Configuration Parameters]]
|[[Global Address Object:Input Parameters|Input Parameters]]
|-
|-
|[[Global Address Object:Input Address Data Parameters|Input Address Data Parameters]]
|[[Global Address Object:Output Parameters|Output Parameters]]
|-
|[[Global Address Object:Output Address Data Parameters|Output Address Data Parameters]]
|}
|}
|-
|-
Line 70: Line 68:
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.
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==
==[[Global Address Object:Input Paramters|Input Parameters]]==
All of the following inputs can be set using SetInputParamter and can also be output using GetOutputParameter.
All of the following inputs can be set using SetInputParamter and can also be output using GetOutputParameter.
===Processing Configuration Parameters===
===[[Global Address Object:Input Paramters#Processing Configuration Parameters|Processing Configuration Parameters]]===
*outputPreference
*outputPreference
*inputFormattedAddressSeparator
*inputFormattedAddressSeparator


===Input Address Parameters===
===[[Global Address Object:Input Paramters#Input Address Parameters|Input Address Parameters]]===
*organization
*organization
*inputAddressLine1
*inputAddressLine1
Line 98: Line 96:




==Output==
==[[Global Address Object:Output Parameters|Output Parameters]]==
===Output Detail Parameters===
===[[Global Address Object:Output Parameters#Output Detail Parameters|Output Detail Parameters]]===
*buildNumber
*buildNumber
*databaseDate
*databaseDate
Line 112: Line 110:
*utc
*utc


===Output Address Parameters===
===[[Global Address Object:Output Parameters#Output Address Parameters|Output Address Parameters]]===
*organization
*addressLine1
*addressLine1
*addressLine2
*addressLine2
Line 123: Line 122:
*country
*country


====Parsed Sub-Premises Parameters====
====[[Global Address Object:Output Parameters#Parsed Sub-Premises Parameters|Parsed Sub-Premises Parameters]]====
*building
*building
*subPremises
*subPremisesNumber
*subPremisesNumber
*subPremisesType
*subPremisesType


====Parsed Thoroughfare Parameters====
====[[Global Address Object:Output Parameters#Parsed Thoroughfare Parameters|Parsed Thoroughfare Parameters]]====
*premises
*premises
*premisesNumber
*premisesNumber
Line 140: Line 140:
*thoroughfareTypeAttached
*thoroughfareTypeAttached


====Parsed Dependent Thoroughfare Columns====
====[[Global Address Object:Output Parameters#Parsed Dependent Thoroughfare Columns|Parsed Dependent Thoroughfare Columns]]====
*dependentThoroughfare
*dependentThoroughfare
*dependentThoroughfareConjunction
*dependentThoroughfareConjunction
Line 150: Line 150:
*dependentThoroughfareTypeAttached
*dependentThoroughfareTypeAttached


====Parsed Postal Facility Columns====
====[[Global Address Object:Output Parameters#Parsed Postal Facility Columns|Parsed Postal Facility Columns]]====
*carrierRoute
*parsedDeliveryInstallation
*parsedDeliveryInstallation
*parsedLockBox
*parsedLockBox
Line 157: Line 158:
*parsedRouteService
*parsedRouteService
*postBox
*postBox
*postalCode
*zipType


====Parsed Regional Columns====
====[[Global Address Object:Output Parameters#Parsed Regional Columns|Parsed Regional Columns]]====
 
*administrativeArea
*cityAbbreviation
*congressionalDistrict
*countyFips
*countyName
*dependentLocality
*doubleDependentLocality
*locality
*subAdministrativeArea
*subNationalArea
*urbanization


===Extra Output Adress Parameters===
===[[Global Address Object:Output Parameters#Extra Output Address Parameters|Extra Output Address Parameters]]===
*addressKey
*addressKey
*addressTypeCode
*addressTypeCode
Line 171: Line 184:
*longitude
*longitude


====Extra Output Country Parameters====
====[[Global Address Object:Output Parameters#Extra Output Country Parameters|Extra Output Country Parameters]]====
*countryAbbreviation
*countryAbbreviation
*countryCode
*countryCode
Line 178: Line 191:
*iso3Code
*iso3Code
*isoCountryNumber
*isoCountryNumber
===US only Output===
*carrierRoute
*cityAbbreviation
*congressionalDistrict
*countyFips
*countyName
*urbanization
*zipType
===Input Often Used in Output===
Parsed regional???
The following parameters are inputs that are often used in the output. They will only be returned if they are first input using SetInputParameter.
*organization
*subPremises
*doubleDependentLocality
*dependentLocality
*locality
*subAdministrativeArea
*administrativeArea
*subNationalArea
*postalCode




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

Revision as of 18:32, 27 August 2014

← Global Address Object Reference

Global Address Object Navigation
Introduction
Platforms and Functions
Licensing
Result Code Use
Interface
Address Handling
Interface Use
Methods
Setup Methods
Input Methods
Processing Methods
Output Methods
Parameters
Input Parameters
Output 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 SetInputParamter and can also be output using GetOutputParameter.

Processing Configuration Parameters

  • outputPreference
  • inputFormattedAddressSeparator

Input Address Parameters

  • organization
  • inputAddressLine1
  • inputAddressLine2
  • inputAddressLine3
  • inputAddressLine4
  • inputAddressLine5
  • inputAddressLine6
  • inputAddressLine7
  • inputAddressLine8
  • subPremises
  • doubleDependentLocality
  • dependentLocality
  • locality
  • subAdministrativeArea
  • administrativeArea
  • subNationalArea
  • postalCode
  • inputCountry
  • countryOfOrigin


Output Parameters

Output Detail Parameters

  • buildNumber
  • databaseDate
  • databaseExpirationDate
  • dst
  • initializeErrorString
  • licensedCountries
  • licenseStringExpirationDate
  • remnants
  • resultCodes
  • timezone
  • utc

Output Address Parameters

  • organization
  • addressLine1
  • addressLine2
  • addressLine3
  • addressLine4
  • addressLine5
  • addressLine6
  • addressLine7
  • addressLine8
  • country

Parsed Sub-Premises Parameters

  • building
  • subPremises
  • subPremisesNumber
  • subPremisesType

Parsed Thoroughfare Parameters

  • premises
  • premisesNumber
  • premisesType
  • thoroughfare
  • thoroughfareLeadingType
  • thoroughfareName
  • thoroughfarePostDirection
  • thoroughfarePreDirection
  • thoroughfareTrailingType
  • thoroughfareTypeAttached

Parsed Dependent Thoroughfare Columns

  • dependentThoroughfare
  • dependentThoroughfareConjunction
  • dependentThoroughfareLeadingType
  • dependentThoroughfareName
  • dependentThoroughfarePostDirection
  • dependentThoroughfarePreDirection
  • dependentThoroughfareTrailingType
  • dependentThoroughfareTypeAttached

Parsed Postal Facility Columns

  • carrierRoute
  • parsedDeliveryInstallation
  • parsedLockBox
  • parsedPrivateMailboxName
  • parsedPrivateMailboxNumber
  • parsedRouteService
  • postBox
  • postalCode
  • zipType

Parsed Regional Columns

  • administrativeArea
  • cityAbbreviation
  • congressionalDistrict
  • countyFips
  • countyName
  • dependentLocality
  • doubleDependentLocality
  • locality
  • subAdministrativeArea
  • subNationalArea
  • urbanization

Extra Output Address Parameters

  • addressKey
  • addressTypeCode
  • addressTypeString
  • deliveryline
  • formattedAddress
  • latitude
  • localityLine
  • longitude

Extra Output Country Parameters

  • countryAbbreviation
  • countryCode
  • countryName
  • iso2Code
  • iso3Code
  • isoCountryNumber