Difference between revisions of "Global Address Object:Input Parameters"

From Melissa Data Wiki
Jump to navigation Jump to search
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Global Address Object:Reference|← Global Address Object Reference]]
{{GlobalAddressObjectNav
|ParametersCollapse=
}}


{| class="mw-collapsible" cellspacing="2" style="background-color:#f9f9f9; border:1px solid #aaaaaa; font-size:9pt; color:#0645ad; padding:8px 8px;"
{{CustomTOC}}
! style="text-align:left; color:black; border-bottom:1px solid #aaaaaa;"|'''Global Address Object Navigation'''
 
|-
Though they are listed in mixed case, the parameters are not case sensitive.
| style="padding-right:220px;"|
 
All of the following inputs can be set using SetInputParamter and can also be output using GetOutputParameter.
 
==Processing Configuration Parameters==
<h3 class="h3grey">countryOfOrigin</h3>
:The country of origin (the address being validated is the destination). Used to determine whether the destination country should be added to the formatted address.
 
:{| class="alternate01 sortable"
!Option Name !! Parameter !! Description
|-
|-
|'''countryOfOrigin'''
|(Any valid ISO-3166-1 Alpha-2, ISO-3166-1 Alpha-3, or ISO-3166-1 Numeric code)
|
|
{| class="mw-collapsible mw-collapsed" style="width:100%;"
*If blank, invalid, or the same as the destination country, then the destination country is not appended to the end of the formatted address.
|- align="left"
*If valid and different from the destination country, then the destination country is appended to the formatted address.
! style="color:black;"|[[Global Address Object:Introduction|Introduction]]
*US or US Territory:
:*If '''''countryOfOrigin''''' and destination country being verified are both US or US Territories then the country will not be appended to '''''formattedAddress'''''.
:*US Territories will have "United States of America" appended if the '''''countryOfOrigin''''' is not a US Territory, but the '''''countryName''''' and ISO codes will be that of the territory.
:*Canada is treated like any other non-US Territory.
|}
 
 
<h3 class="h3grey">outputPreference</h3>
:This is the script type used for all applicable fields.
 
:{| class="alternate01 sortable"
!Option Name !! Parameter !! Description
|-
|-
|[[Global Address Object:Platforms and Functions|Platforms and Functions]]
|rowspan="3"|'''outputPreference'''||<code>[Blank]</code>||'''''Default.''''' Returns the same script that is sent in.
|-
|-
|[[Global Address Object:Licensing|Licensing]]
|<code>LATIN</code>||Returns in the Latin script.
|-
|-
|[[Global Address Object:Result Code Use|Result Code Use]]
|<code>NATIVE</code>||Returns in the native script for the designated country.
|}
|}
<h3 class="h3grey">inputFormattedAddressSeparator</h3>
:This is a string used to delimit line in the '''''formattedAddress''''' output field. This string can be one or multiple characters.
<!--
<h3 class="h3grey">CASS Mode</h3>
:The CASS (Coding Accuracy Support System) form is the USPS form for mailing discounts
:{| class="alternate01 sortable"
!Input Parameter !! Input Value !! Description
|-
|-
|
|USCASSEnable||<code>True</code> or <code>False</code>||False is enabled by default. Set to True to be able to generate a CASS Form.
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Address Object:Interface|Interface]]
|-
|[[Global Address Object:Address Handling|Address Handling]]
|-
|-
|[[Global Address Object:Interface Use|Interface Use]]
|USSaveCASSForm||<code>[File Path]</code>||Path and filename to save CASS Form to with .HTML or .PDF extension
|}
|}
<h3 class="h3grey">SOA Mode</h3>
:The SOA (Statement of Accuracy) form is the CanadaPost form for mailing discounts
:{| class="alternate01 sortable"
!Input Parameter !! Input Value !! Description
|-
|-
|
|CASOAFormName||<code>[Text]</code>||Name to use on the SOA Form
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Address Object:Functions|Functions]]
|-
|-
|[[Global Address Object:Setup Functions|Setup Functions]]
|CASOAFormAddress||<code>[Text]</code>||Address to use on the SOA Form
|-
|-
|[[Global Address Object:Input Methods|Input Methods]]
|CASOACPCNumber||<code>[Text]</code>||CPC Number to use on the SOA Form
|-
|-
|[[Global Address Object:Processing Methods|Processing Methods]]
|CASaveSOAForm||<code>[File Path]</code>||Path and filename to save SOA Form to with .HTML extension
|-
|[[Global Address Object:Output Methods|Output Methods]]
|}
|}
<h3 class="h3grey">Additional Inputs</h3>
:{| class="alternate01 sortable"
!Input Parameter !! Input Value !! Description
|-
|-
|
|USPreferredCityNames||<code>True</code> or <code>False</code>||False is enabled by default. If set to true, all vanity city names will be overwritten by the USPS Preferred City Name on verification. (US Only)
{| class="mw-collapsible" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Address Object:Parameters|Parameters]]
|-
|-
|[[Global Address Object:Processing Configuration Parameters|Processing Configuration Parameters]]
|USStandardizationType||<code>Auto</code> or <code>Short</code> or <code>Long</code>||Auto is enabled by Default which uses USPS preferences. “Short” means all suffixes, prefixes, and directionals will be abbreviated (NW, DR, BLVD). “Long” means all suffixes, prefixes, and directional will be written out (Northwest, Drive, Boulevard). (US Only)
|-
|-
|[[Global Address Object:Input Address Data Parameters|Input Address Data Parameters]]
|USAliasMode||<code>Convert</code> or <code>Preserve</code>||Convert is enabled by default which means if we find a street that is an alias, we will convert it to the preferred street name. Use Preserve to not perform the convert. (US Only)
|-
|-
|[[Global Address Object:Output Address Data Parameters|Output Address Data Parameters]]
|LastName||<code>[Text]</code>||Input LastName in which case  the engine will try and append a missing suite from the address based on the last name. (US Only)
|}
|}-->
|-
 
|
 
{| class="mw-collapsible mw-collapsed" style="width:100%;"
==Input Address Parameters==
|- align="left"
<h3 class="h3grey">inputOrganization</h3>
! style="color:black;"|[[Global Address Object:Result Codes|Result Codes]]
:The organization name associated with the address record.
|-
 
|[[Returned Result Codes:APIs#Global Address Object|Returned Result Codes]]
<h3 class="h3grey">inputAddressLine1</h3>
|-
:''Required.''
|[[Global Address Object:Other Codes|Other Codes]]
 
|}
:The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.
|}
 
 
<h3 class="h3grey">inputAddressLine2</h3>
:''Optional.''
 
:The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.
 
 
<h3 class="h3grey">inputAddressLine3</h3>
:''Optional.''
 
:The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.
 
 
<h3 class="h3grey">inputAddressLine4</h3>
:''Optional.''


:The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.


{{CustomTOC}}


Though they are listed in mixed case, the parameters are not case sensitive.
<h3 class="h3grey">inputAddressLine5</h3>
:''Optional.''


==General==
:The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.
===inputXML===
Address input formed utilizing the MelissaData published DTD for XML. The XML should include all address input elements for processing in '''verifyAddress'''.




==Organization==
<h3 class="h3grey">inputAddressLine6</h3>
===inputOrganization===
:''Optional.''
The name of an organization provided as input for address processing.


:The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.


==Address Lines==
Output values for address lines 1-8.


===inputAddressLine1===
<h3 class="h3grey">inputAddressLine7</h3>
:''Optional.''


===inputAddressLine2===
:The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.


===inputAddressLine3===


===inputAddressLine4===
<h3 class="h3grey">inputAddressLine8</h3>
:''Optional.''


===inputAddressLine5===
:The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.


===inputAddressLine6===


===inputAddressLine7===
<h3 class="h3grey">inputDoubleDependentLocality</h3>
:''Optional.''


===inputAddressLine8===
:The smallest population center data element. This depends on the Locality and DependentLocality elements.


===inputFormattedAddress===
This parameter provides for the input of all address lines in a single string value with the defined '''lineSeparator''' for parsing.


<h3 class="h3grey">inputDependentLocality</h3>
:''Optional.''


==Locality Levels==
:The smaller population center data element. This depends on the Locality element.
These include village, town, city, borough, and district.


===inputDoubleDependentLocality===
:'''US Term:''' Urbanization
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===
:In terms of US Addresses, this element applies only to Puerto Rican addresses. It is used to break ties when a ZIP Code™ is linked to multiple instances of the same address.
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===
<h3 class="h3grey">inputLocality</h3>
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.
:''Required.''


:The most common population center data element.


==Administrative Area and Higher==
:'''US Term:''' City
These include province, state, county, prefecture, territory, and country. All inputs allow for abbreviated values.
:'''Canada Term:''' Municipality


===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===
<h3 class="h3grey">inputSubAdministrativeArea</h3>
This is the most common geographic data element. This is a state or province in countries like the United States, Canada, and Australia.
:''Optional.''


===inputSubNationalArea===
:The smallest geographic data element.
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===
:'''US Term:''' County
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===
<h3 class="h3grey">inputAdministrativeArea</h3>
This is the input ISO2 or ISO3 country code.
:''Required.''


===inputCountryNumber===
:The most common geographic data element.
This is the input ISO country number.


:'''US Term:''' State
:'''Canada Term:''' Province


==Address Thoroughfare and Premise==
===inputpostBox===
This is the input value for Post Office Box


===premiseNumber===
<h3 class="h3grey">inputSubNationalArea</h3>
This is the house number or premise number for the input address.
:''Optional.''


===premiseType===
:The administrative region within a country on an arbitrary level below that of the sovereign state.


===subPremiseNumber===


===subPremiseType===
<h3 class="h3grey">inputPostalCode</h3>
:''Required.''


===thoroughfareLeadingType===
:The complete postal code for a particular delivery point.


===thoroughfare===
:'''US Term:''' ZIP
:'''Canadian Term:''' Postcode


===thoroughfarePostDirection===
:If all three elements are provided and the PostalCode is incorrect, it can be corrected from the data on the Locality and AdministrativeArea.


===thoroughfarePreDirection===


===thoroughfareTrailingType===
<h3 class="h3grey">inputCountry</h3>
:''Required.''


===thoroughfareTrailingTypeAttached===
:The country name, abbreviation, or code.




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

Latest revision as of 17:18, 21 June 2022

← Global Address Object Reference

Global Address Object Navigation
Introduction
System Requirements
Setup
Licensing
Interface
Address Handling
Interface Use
Methods
Setup Methods
Input Methods
Processing Methods
Output Methods
Parameters
Input Parameters
Output Parameters
Result Codes
Global Address Object 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 of origin (the address being validated is the destination). Used to determine whether the destination country should be added to the formatted address.
Option Name Parameter Description
countryOfOrigin (Any valid ISO-3166-1 Alpha-2, ISO-3166-1 Alpha-3, or ISO-3166-1 Numeric code)
  • If blank, invalid, or the same as the destination country, then the destination country is not appended to the end of the formatted address.
  • If valid and different from the destination country, then the destination country is appended to the formatted address.
  • US or US Territory:
  • If countryOfOrigin and destination country being verified are both US or US Territories then the country will not be appended to formattedAddress.
  • US Territories will have "United States of America" appended if the countryOfOrigin is not a US Territory, but the countryName and ISO codes will be that of the territory.
  • Canada is treated like any other non-US Territory.


outputPreference

This is the script type used for all applicable fields.
Option Name Parameter Description
outputPreference [Blank] Default. Returns the same script that is sent in.
LATIN Returns in the Latin script.
NATIVE Returns in the native script for the designated country.


inputFormattedAddressSeparator

This is a string used to delimit line in the formattedAddress output field. This string can be one or multiple characters.


Input Address Parameters

inputOrganization

The organization name associated with the address record.

inputAddressLine1

Required.
The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.


inputAddressLine2

Optional.
The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.


inputAddressLine3

Optional.
The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.


inputAddressLine4

Optional.
The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.


inputAddressLine5

Optional.
The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.


inputAddressLine6

Optional.
The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.


inputAddressLine7

Optional.
The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.


inputAddressLine8

Optional.
The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.


inputDoubleDependentLocality

Optional.
The smallest population center data element. This depends on the Locality and DependentLocality elements.


inputDependentLocality

Optional.
The smaller population center data element. This depends on the Locality element.
US Term: Urbanization
In terms of US Addresses, this element applies only to Puerto Rican addresses. It is used to break ties when a ZIP Code™ is linked to multiple instances of the same address.


inputLocality

Required.
The most common population center data element.
US Term: City
Canada Term: Municipality


inputSubAdministrativeArea

Optional.
The smallest geographic data element.
US Term: County


inputAdministrativeArea

Required.
The most common geographic data element.
US Term: State
Canada Term: Province


inputSubNationalArea

Optional.
The administrative region within a country on an arbitrary level below that of the sovereign state.


inputPostalCode

Required.
The complete postal code for a particular delivery point.
US Term: ZIP
Canadian Term: Postcode
If all three elements are provided and the PostalCode is incorrect, it can be corrected from the data on the Locality and AdministrativeArea.


inputCountry

Required.
The country name, abbreviation, or code.
Retrieved from "http://wiki.melissadata.com/index.php?title=Global_Address_Object:Input_Parameters&oldid=18924"