Global Address Object:Input Parameters: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
← Older editNewer edit →
No edit summary
No edit summary
Line 68: Line 68:
Though they are listed in mixed case, the parameters are not case sensitive.
Though they are listed in mixed case, the parameters are not case sensitive.


==General==
All of the following inputs can be set using SetInputParamter and can also be output using GetOutputParameter.
===inputXML===
Address input formed utilizing the MelissaData published DTD for XML. The XML should include all address input elements for processing in '''verifyAddress'''.


==Processing Configuration Parameters==
===countryOfOrigin===
The country from which the input file originated from.


==Organization==
===outputPreference===
===inputOrganization===
The name of an organization provided as input for address processing.


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


==Address Lines==
 
Output values for address lines 1-8.
==Input Address Parameters==
===organization===
'''''Business''''' or '''''Company'''''.


===inputAddressLine1===
===inputAddressLine1===
===inputAddressLine2===
===inputAddressLine2===
===inputAddressLine3===
===inputAddressLine3===
===inputAddressLine4===
===inputAddressLine4===
===inputAddressLine5===
===inputAddressLine5===
===inputAddressLine6===
===inputAddressLine6===
===inputAddressLine7===
===inputAddressLine7===
===inputAddressLine8===
===inputAddressLine8===
===subPremises===
'''''Suite'''''. Alphanumeric code identifying an individual location.


===inputFormattedAddress===
===doubleDependentLocality===
This parameter provides for the input of all address lines in a single string value with the defined '''lineSeparator''' for parsing.
Smallest population center data element.
 
 
==Locality Levels==
These include village, town, city, borough, and district.


===inputDoubleDependentLocality===
===dependentLocality===
Specifies the distinct input value for double dependent locality. This is a string value for the smallest population center data element. This depends on the Locality and DependentLocality elements.
'''''Urbanization'''''. Smaller population center data element. Dependent on Locality.


===inputDependentLocality===
===locality===
Specifies the distinct input value for dependent locality. This is a string value for a smaller population center data element and depends on the Locality element. For example, an urbanization in Puerto Rico.
'''''City'''''. Most common population center data element.


===inputLocality===
===subAdministrativeArea===
Specifies the distinct input value for locality. This is a string value for the most common population center data element. For example, a city or municipality.
'''''County'''''. Smallest geographic data element.


===inputPostalCode===
===administrativeArea===
Specifies the distinct input value for postal code. In the US this is a zip code and not all countries support a postal code. To receive a valid result all input addresses should contain a postal code, locality, and/or administrative area.
'''''State'''''. Most common geographic data element.


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


==Administrative Area and Higher==
===postalCode===
These include province, state, county, prefecture, territory, and country. All inputs allow for abbreviated values.
'''''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.
 
===inputSubAdministrativeArea===
This is the smallest geographic data element. In the US this would be county, but can vary based on individual countries' organization structure.
 
===inputAdministrativeArea===
This is the most common geographic data element. This is a state or province in countries like the United States, Canada, and Australia.
 
===inputSubNationalArea===
This is a country specific administrative classification at an arbitrary level below country. For example, a prefecture in Japan or a canton in Switzerland.


===inputCountry===
===inputCountry===
This is the input country name, code, number, or abbreviation.
The country of the address.
 
===InputUnreliableCountry===
This is a parameter which allows for a semicolon delimited list of ISO3 country codes to be provided for fielding. These countries are deemed to be override-able if other address elements indicate a different, more accurate input country value.
 
===inputCountryCode===
This is the input ISO2 or ISO3 country code.
 
===inputCountryNumber===
This is the input ISO country number.
 
 
==Address Thoroughfare and Premise==
===inputpostBox===
This is the input value for Post Office Box
 
===premiseNumber===
This is the house number or premise number for the input address.
 
===premiseType===
 
===subPremiseNumber===
 
===subPremiseType===
 
===thoroughfareLeadingType===
 
===thoroughfare===
 
===thoroughfarePostDirection===
 
===thoroughfarePreDirection===
 
===thoroughfareTrailingType===
 
===thoroughfareTrailingTypeAttached===




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

Revision as of 00:24, 28 August 2014

← 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
Input Parameters
Output Parameters
Result Codes
Returned Result Codes
Other Codes



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

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

Processing Configuration Parameters

countryOfOrigin

The country from which the input file originated from.

outputPreference

inputFormattedAddressSeparator

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


Input Address Parameters

organization

Business or Company.

inputAddressLine1

inputAddressLine2

inputAddressLine3

inputAddressLine4

inputAddressLine5

inputAddressLine6

inputAddressLine7

inputAddressLine8

subPremises

Suite. Alphanumeric code identifying an individual location.

doubleDependentLocality

Smallest population center data element.

dependentLocality

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

locality

City. Most common population center data element.

subAdministrativeArea

County. Smallest geographic data element.

administrativeArea

State. Most common geographic data element.

subNationalArea

Arbitrary administrative region below that of the sovereign state.

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.

inputCountry

The country of the address.

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