|
|
| 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. |
|
| |
|
| ==Organization== | | ==Output Detail Parameters== |
| ===outputOrganization=== | | ===buildNumber=== |
| The name of an organization provided as output for address processing.
| | ===databaseDate=== |
| | ===databaseExpirationDate=== |
| | ===dst=== |
| | ===initializeErrorString=== |
| | ===licensedCountries=== |
| | ===licenseStringExpirationDate=== |
| | ===remnants=== |
| | ===resultCodes=== |
| | ===timezone=== |
| | ===utc=== |
|
| |
|
| | ==Output Address Parameters== |
| | ===organization=== |
| | ===addressLine1=== |
| | ===addressLine2=== |
| | ===addressLine3=== |
| | ===addressLine4=== |
| | ===addressLine5=== |
| | ===addressLine6=== |
| | ===addressLine7=== |
| | ===addressLine8=== |
| | ===country=== |
|
| |
|
| ==Address Lines== | | ==Parsed Sub-Premises Parameters== |
| Output values for address lines 1-8.
| | ===building=== |
| | ===subPremises=== |
| | ===subPremisesNumber=== |
| | ===subPremisesType=== |
|
| |
|
| ===outputAddressLine1=== | | ==Parsed Thoroughfare Parameters== |
| | ===premises=== |
| | ===premisesNumber=== |
| | ===premisesType=== |
| | ===thoroughfare=== |
| | ===thoroughfareLeadingType=== |
| | ===thoroughfareName=== |
| | ===thoroughfarePostDirection=== |
| | ===thoroughfarePreDirection=== |
| | ===thoroughfareTrailingType=== |
| | ===thoroughfareTypeAttached=== |
|
| |
|
| ===outputAddressLine2=== | | ==Parsed Dependent Thoroughfare Columns== |
| | ===dependentThoroughfare=== |
| | ===dependentThoroughfareConjunction=== |
| | ===dependentThoroughfareLeadingType=== |
| | ===dependentThoroughfareName=== |
| | ===dependentThoroughfarePostDirection=== |
| | ===dependentThoroughfarePreDirection=== |
| | ===dependentThoroughfareTrailingType=== |
| | ===dependentThoroughfareTypeAttached=== |
|
| |
|
| ===outputAddressLine3=== | | ==Parsed Postal Facility Columns== |
| | ===carrierRoute=== |
| | ===parsedDeliveryInstallation=== |
| | ===parsedLockBox=== |
| | ===parsedPrivateMailboxName=== |
| | ===parsedPrivateMailboxNumber=== |
| | ===parsedRouteService=== |
| | ===postBox=== |
| | ===postalCode=== |
| | ===zipType=== |
|
| |
|
| ===outputAddressLine4=== | | ==Parsed Regional Columns== |
| | ===administrativeArea=== |
| | ===cityAbbreviation=== |
| | ===congressionalDistrict=== |
| | ===countyFips=== |
| | ===countyName=== |
| | ===dependentLocality=== |
| | ===doubleDependentLocality=== |
| | ===locality=== |
| | ===subAdministrativeArea=== |
| | ===subNationalArea=== |
| | ===urbanization=== |
|
| |
|
| ===outputAddressLine5===
| |
|
| |
|
| ===outputAddressLine6=== | | ==Extra Output Address Parameters== |
| | ===addressKey=== |
| | ===addressTypeCode=== |
| | ===addressTypeString=== |
| | ===deliveryline=== |
| | ===formattedAddress=== |
| | ===latitude=== |
| | ===localityLine=== |
| | ===longitude=== |
|
| |
|
| ===outputAddressLine7=== | | ==Extra Output Country Parameters== |
| | | ===countryAbbreviation=== |
| ===outputAddressLine8===
| | ===countryCode=== |
| | | ===countryName=== |
| ===outputFormattedAddress===
| | ===iso2Code=== |
| This parameter provides for the output of all address lines in a single string value with the defined '''lineSeparator''' for parsing.
| | ===iso3Code=== |
| | | ===isoCountryNumber=== |
| | |
| ==Locality Levels==
| |
| These include village, town, city, borough, and district.
| |
| | |
| ===outputDoubleDependentLocality===
| |
| Specifies the distinct output 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.
| |
| | |
| ===outputDependentLocality===
| |
| Specifies the distinct output 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.
| |
| | |
| ===outputLocality===
| |
| Specifies the distinct output value for locality. This is a string value for the most common population center data element. For example, a city or municipality.
| |
| | |
| ===outputPostalCode===
| |
| Specifies the distinct output 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 output 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 outputs are formed based on accepted postal formatting standards in the destination country.
| |
| | |
| ===outputSubAdministrativeArea===
| |
| This is the smallest geographic data element. In the US this would be county, but can vary based on individual countries' organization structure.
| |
| | |
| ===outputAdministrativeArea===
| |
| This is the most common geographic data element. This is a state or province in countries like the United States, Canada, and Australia.
| |
| | |
| ===outputSubNationalArea===
| |
| This is a country specific administrative classification at an arbitrary level below country. For example, a prefecture in Japan or a canton in Switzerland.
| |
| | |
| ===outputCountry===
| |
| This is the output country name, code, number, or abbreviation
| |
| | |
| ===outputCountryCode===
| |
| This is the output ISO2 or ISO3 country code.
| |
| | |
| ===outputCountryNumber===
| |
| This is the output ISO country number.
| |
| | |
| | |
| ==Address Thoroughfare and Premise==
| |
| ===outputPostBox===
| |
| This is the output value for Post Office Box.
| |
| | |
| ===outputPremiseNumber===
| |
| This is the house number or premise number for the output address.
| |
| | |
| ===outputPremiseType===
| |
| | |
| ===outputsubpremiseNumber===
| |
| | |
| ===outputsubpremiseType===
| |
| | |
| ===outputThoroughfareLeadingType===
| |
| | |
| ===outputThoroughfare===
| |
| | |
| ===outputThoroughfareName===
| |
| | |
| ===outputPremise===
| |
| | |
| ===outputThoroughfarePostDirection===
| |
| | |
| ===outputThoroughfarePreDirection===
| |
| | |
| ===outputThoroughfareTrailingType===
| |
| | |
| ===outputThoroughfareTrailingTypeAttached===
| |
| | |
| | |
| | |
| ==Other Output Parameters==
| |
| ===remnant=== | |
| 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.
| |
| | |
| ===outputXML=== | |
| Address Output formed utilizing the Melissa Data published DTD for XML. The XML ''<u>will</u>'' include all address elements returned from verifyAddress.
| |
| | |
| ===outputDST===
| |
| Outputs a true/false value delineating if the given address is in a time zone that supports Daylight Savings Time (DST).
| |
| | |
| ===outputTimeZone=== | |
| Outputs named time zone for the given address.
| |
| | |
| ===outputUTC=== | |
| Outputs the UTC offset for the time in the given time zone of the address.
| |
| | |
| ===outputLanguage=== | |
| Outputs the supported language in the country of the address.
| |
| | |
| ===outputAlphabet=== | |
| Outputs the name of the alphabet used in the address output result.
| |
| | |
| ===resultCode===
| |
| This parameter returns the result code(s) scoring the address results from the Global Address Object.
| |
| | |
| ===detailCode===
| |
| This parameter returns the detail code for the given address output.
| |
|
| |
|
|
| |
|
| [[Category:Global Address Object]] | | [[Category:Global Address Object]] |
| [[Category:Reference]] | | [[Category:Reference]] |