Difference between revisions of "Global Address Object:Parameters"

From Melissa Data Wiki
Jump to navigation Jump to search
Line 68: Line 68:
{{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.


==[[Global Address Object:Processing Configuration Parameters|Processing Configuration Parameters]]==
==Input==
*requestedOutputType
All of the following inputs can be set using SetInputParamter and can also be output using GetOutputParameter.
*requestingCountry
===Processing Configuration Parameters===
*AlphabetOverride
*outputPreference
*lineSeparator
*inputFormattedAddressSeparator
*Case
*Fielding


 
===Input Address Parameters===
==[[Global Address Object:Input Address Data Parameters|Input Address Data Parameters]]==
*organization
===[[Global Address Object:Input Address Data Parameters#General|General]]===
*inputXML
 
===[[Global Address Object:Input Address Data Parameters#Organization|Organization]]===
*inputOrganization
 
===[[Global Address Object:Input Address Data Parameters#Address Lines|Address Lines]]===
*inputAddressLine1
*inputAddressLine1
*inputAddressLine2
*inputAddressLine2
Line 95: Line 86:
*inputAddressLine7
*inputAddressLine7
*inputAddressLine8
*inputAddressLine8
*inputFormattedAddress
*subPremises
*doubleDependentLocality
*dependentLocality
*locality
*subAdministrativeArea
*administrativeArea
*subNationalArea
*postalCode
*inputCountry
*countryOfOrigin
 
 
==Output==
===Output Detail Parameters===
*buildNumber
*databaseDate
*databaseExpirationDate
*dst
*initializeErrorString
*licensedCountries
*licenseStringExpirationDate
*remnants
*resultCodes
*timezone
*utc


===[[Global Address Object:Input Address Data Parameters#Locality Levels|Locality Levels]]===
===Output Address Parameters===
*inputDoubleDependentLocality
*addressLine1
*inputDependentLocality
*addressLine2
*inputLocality
*addressLine3
*inputPostalCode
*addressLine4
*addressLine5
*addressLine6
*addressLine7
*addressLine8
*country


===[[Global Address Object:Input Address Data Parameters#Administrative Area and Higher|Administrative Area and Higher]]===
====Parsed Sub-Premises Parameters====
*inputSubAdministrativeArea
*building
*inputAdministrativeArea
*subPremisesNumber
*inputSubNationalArea
*subPremisesType
*inputCountry
*InputUnreliableCountry
*inputCountryCode
*inputCountryNumber


===[[Global Address Object:Input Address Data Parameters#Address Thoroughfare and Premise|Address Thoroughfare and Premise]]===
====Parsed Thoroughfare Parameters====
*inputpostBox
*premises
*premiseNumber
*premisesNumber
*premiseType
*premisesType
*subPremiseNumber
*thoroughfare
*subPremiseType
*thoroughfareLeadingType
*thoroughfareLeadingType
*thoroughfare
*thoroughfareName
*thoroughfarePostDirection
*thoroughfarePostDirection
*thoroughfarePreDirection
*thoroughfarePreDirection
*thoroughfareTrailingType
*thoroughfareTrailingType
*thoroughfareTrailingTypeAttached
*thoroughfareTypeAttached
 
====Parsed Dependent Thoroughfare Columns====
*dependentThoroughfare
*dependentThoroughfareConjunction
*dependentThoroughfareLeadingType
*dependentThoroughfareName
*dependentThoroughfarePostDirection
*dependentThoroughfarePreDirection
*dependentThoroughfareTrailingType
*dependentThoroughfareTypeAttached
 
====Parsed Postal Facility Columns====
*parsedDeliveryInstallation
*parsedLockBox
*parsedPrivateMailboxName
*parsedPrivateMailboxNumber
*parsedRouteService
*postBox
 
====Parsed Regional Columns====
 
 
===Extra Output Adress Parameters===
*addressKey
*addressTypeCode
*addressTypeString
*formattedAddress
*latitude
*longitude
 
====Extra Output Country Parameters====
*countryAbbreviation
*countryCode
*countryName
*iso2Code
*iso3Code
*isoCountryNumber
 
 
carrierRoute - US only
 
cityAbbreviation - US only
 
congressionalDistrict - US only


countyFips - US only


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


===[[Global Address Object:Output Address Data Parameters#Address Lines|Address Lines]]===
localityLine - ?
*outputAddressLine1
*outputAddressLine2
*outputAddressLine3
*outputAddressLine4
*outputAddressLine5
*outputAddressLine6
*outputAddressLine7
*outputAddressLine8
*outputFormattedAddress


===[[Global Address Object:Output Address Data Parameters#Locality Levels|Locality Levels]]===
urbanization - (dependent locality?)
*outputDoubleDependentLocality
*outputDependentLocality
*outputLocality
*outputPostalCode


===[[Global Address Object:Output Address Data Parameters#Administrative Area and Higher|Administrative Area and Higher]]===
zipType - (postal code? or US only)
*outputSubAdministrativeArea
*outputAdministrativeArea
*outputSubNationalArea
*outputCountry
*outputCountryCode
*outputCountryNumber


===[[Global Address Object:Output Address Data Parameters#Address Thoroughfare and Premise|Address Thoroughfare and Premise]]===
===Input Often Used in Output===
*outputPostBox
The following parameters are inputs that are often used in the output. They will only be returned if they are first input using SetInputParameter.
*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]]===
*organization
*remnant
*subPremises
*outputXML
*doubleDependentLocality
*outputDST
*dependentLocality
*outputTimeZone
*locality
*outputUTC
*subAdministrativeArea
*outputLanguage
*administrativeArea
*outputAlphabet
*subNationalArea
*resultCode
*postalCode
*detailCode




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

Revision as of 22:42, 26 August 2014

← Global Address Object Reference

Global Address Object Navigation
Introduction
Platforms and Functions
Licensing
Result Code Use
Interface
Address Handling
Interface Use
Functions
Setup Functions
Input Methods
Processing Methods
Output Methods
Parameters
Processing Configuration Parameters
Input Address Data Parameters
Output Address Data 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

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

Output Detail Parameters

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

Output Address Parameters

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

Parsed Sub-Premises Parameters

  • building
  • 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

  • parsedDeliveryInstallation
  • parsedLockBox
  • parsedPrivateMailboxName
  • parsedPrivateMailboxNumber
  • parsedRouteService
  • postBox

Parsed Regional Columns

Extra Output Adress Parameters

  • addressKey
  • addressTypeCode
  • addressTypeString
  • formattedAddress
  • latitude
  • longitude

Extra Output Country Parameters

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


carrierRoute - US only

cityAbbreviation - US only

congressionalDistrict - US only

countyFips - US only

deliveryline - ?

localityLine - ?

urbanization - (dependent locality?)

zipType - (postal code? or US only)

Input Often Used in Output

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