Global Address Object:Input Parameters: Difference between revisions
Created page with "← Global Address Object Reference {| class="mw-collapsible" cellspacing="2" style="background-color:#f9f9f9; border:1px solid #aaaaaa..." |
No edit summary |
||
| Line 81: | Line 81: | ||
==Address Lines== | ==Address Lines== | ||
Output values for address lines 1-8. | |||
===inputAddressLine1=== | ===inputAddressLine1=== | ||
| Line 103: | Line 105: | ||
==Locality Levels== | ==Locality Levels== | ||
These include village, town, city, borough, and district. | These include village, town, city, borough, and district. | ||
===inputDoubleDependentLocality=== | ===inputDoubleDependentLocality=== | ||
Specifies the distinct input value for double dependent locality. This is a string value for the smallest population center data element. | 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. | ||
===inputDependentLocality=== | ===inputDependentLocality=== | ||
| Line 118: | Line 121: | ||
==Administrative Area and Higher== | ==Administrative Area and Higher== | ||
These include province, state, county, prefecture, territory, and country. All inputs allow for abbreviated values. | These include province, state, county, prefecture, territory, and country. All inputs allow for abbreviated values. | ||
===inputSubAdministrativeArea=== | ===inputSubAdministrativeArea=== | ||
This is the smallest geographic data element. In the US this would be county, but can vary based on individual countries' organization structure. | This is the smallest geographic data element. In the US this would be county, but can vary based on individual countries' organization structure. | ||
| Line 148: | Line 152: | ||
===premiseType=== | ===premiseType=== | ||
===subPremiseNumber=== | ===subPremiseNumber=== | ||
===subPremiseType=== | ===subPremiseType=== | ||
===thoroughfareLeadingType=== | ===thoroughfareLeadingType=== | ||
===thoroughfare=== | ===thoroughfare=== | ||
===thoroughfarePostDirection=== | ===thoroughfarePostDirection=== | ||
===thoroughfarePreDirection=== | ===thoroughfarePreDirection=== | ||
===thoroughfareTrailingType=== | ===thoroughfareTrailingType=== | ||
===thoroughfareTrailingTypeAttached=== | ===thoroughfareTrailingTypeAttached=== | ||
Revision as of 22:22, 6 August 2014
← Global Address Object Reference
Though they are listed in mixed case, the parameters are not case sensitive.
General
inputXML
Address input formed utilizing the MelissaData published DTD for XML. The XML should include all address input elements for processing in verifyAddress.
Organization
inputOrganization
The name of an organization provided as input for address processing.
Address Lines
Output values for address lines 1-8.
inputAddressLine1
inputAddressLine2
inputAddressLine3
inputAddressLine4
inputAddressLine5
inputAddressLine6
inputAddressLine7
inputAddressLine8
inputFormattedAddress
This parameter provides for the input of all address lines in a single string value with the defined lineSeparator for parsing.
Locality Levels
These include village, town, city, borough, and district.
inputDoubleDependentLocality
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.
inputDependentLocality
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.
inputLocality
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.
inputPostalCode
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.
Administrative Area and Higher
These include province, state, county, prefecture, territory, and country. All inputs allow for abbreviated values.
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
This is the input country name, code, number, or abbreviation.
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.