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 10: Line 10:


==Processing Configuration Parameters==
==Processing Configuration Parameters==
<h3 style="background-color:rgb(240,240,240);">countryOfOrigin</h3>
<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.
: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.


Line 28: Line 28:




<h3 style="background-color:rgb(240,240,240);">outputPreference</h3>
<h3 class="h3grey">outputPreference</h3>
:This is the script type used for all applicable fields.
:This is the script type used for all applicable fields.


Line 42: Line 42:




<h3 style="background-color:rgb(240,240,240);">inputFormattedAddressSeparator</h3>
<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.
: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.
|-
|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
|-
|CASOAFormAddress||<code>[Text]</code>||Address to use on the SOA Form
|-
|CASOACPCNumber||<code>[Text]</code>||CPC Number to use on the SOA Form
|-
|CASaveSOAForm||<code>[File Path]</code>||Path and filename to save SOA Form to with .HTML extension
|}
<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)
|-
|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)
|-
|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)
|-
|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)
|}




==Input Address Parameters==
==Input Address Parameters==
<h3 style="background-color:rgb(240,240,240);">inputOrganization</h3>
<h3 class="h3grey">inputOrganization</h3>
:The organization name associated with the address record.
:The organization name associated with the address record.


<h3 style="background-color:rgb(240,240,240);">inputAddressLine1</h3>
<h3 class="h3grey">inputAddressLine1</h3>
:''Required.''
:''Required.''


Line 56: Line 98:




<h3 style="background-color:rgb(240,240,240);">inputAddressLine2</h3>
<h3 class="h3grey">inputAddressLine2</h3>
:''Optional.''
:''Optional.''


Line 62: Line 104:




<h3 style="background-color:rgb(240,240,240);">inputAddressLine3</h3>
<h3 class="h3grey">inputAddressLine3</h3>
:''Optional.''
:''Optional.''


Line 68: Line 110:




<h3 style="background-color:rgb(240,240,240);">inputAddressLine4</h3>
<h3 class="h3grey">inputAddressLine4</h3>
:''Optional.''
:''Optional.''


Line 74: Line 116:




<h3 style="background-color:rgb(240,240,240);">inputAddressLine5</h3>
<h3 class="h3grey">inputAddressLine5</h3>
:''Optional.''
:''Optional.''


Line 80: Line 122:




<h3 style="background-color:rgb(240,240,240);">inputAddressLine6</h3>
<h3 class="h3grey">inputAddressLine6</h3>
:''Optional.''
:''Optional.''


Line 86: Line 128:




<h3 style="background-color:rgb(240,240,240);">inputAddressLine7</h3>
<h3 class="h3grey">inputAddressLine7</h3>
:''Optional.''
:''Optional.''


Line 92: Line 134:




<h3 style="background-color:rgb(240,240,240);">inputAddressLine8</h3>
<h3 class="h3grey">inputAddressLine8</h3>
:''Optional.''
:''Optional.''


Line 98: Line 140:




<h3 style="background-color:rgb(240,240,240);">inputDoubleDependentLocality</h3>
<h3 class="h3grey">inputDoubleDependentLocality</h3>
:''Optional.''
:''Optional.''


Line 104: Line 146:




<h3 style="background-color:rgb(240,240,240);">inputDependentLocality</h3>
<h3 class="h3grey">inputDependentLocality</h3>
:''Optional.''
:''Optional.''


Line 114: Line 156:




<h3 style="background-color:rgb(240,240,240);">inputLocality</h3>
<h3 class="h3grey">inputLocality</h3>
:''Required.''
:''Required.''


Line 123: Line 165:




<h3 style="background-color:rgb(240,240,240);">inputSubAdministrativeArea</h3>
<h3 class="h3grey">inputSubAdministrativeArea</h3>
:''Optional.''
:''Optional.''


Line 131: Line 173:




<h3 style="background-color:rgb(240,240,240);">inputAdministrativeArea</h3>
<h3 class="h3grey">inputAdministrativeArea</h3>
:''Required.''
:''Required.''


Line 140: Line 182:




<h3 style="background-color:rgb(240,240,240);">inputSubNationalArea</h3>
<h3 class="h3grey">inputSubNationalArea</h3>
:''Optional.''
:''Optional.''


Line 146: Line 188:




<h3 style="background-color:rgb(240,240,240);">inputPostalCode</h3>
<h3 class="h3grey">inputPostalCode</h3>
:''Required.''
:''Required.''


Line 157: Line 199:




<h3 style="background-color:rgb(240,240,240);">inputCountry</h3>
<h3 class="h3grey">inputCountry</h3>
:''Required.''
:''Required.''


Revision as of 00:07, 4 May 2019

← 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.


CASS Mode

The CASS (Coding Accuracy Support System) form is the USPS form for mailing discounts
Input Parameter Input Value Description
USCASSEnable True or False False is enabled by default. Set to True to be able to generate a CASS Form.
USSaveCASSForm [File Path] Path and filename to save CASS Form to with .HTML or .PDF extension


SOA Mode

The SOA (Statement of Accuracy) form is the CanadaPost form for mailing discounts
Input Parameter Input Value Description
CASOAFormName [Text] Name to use on the SOA Form
CASOAFormAddress [Text] Address to use on the SOA Form
CASOACPCNumber [Text] CPC Number to use on the SOA Form
CASaveSOAForm [File Path] Path and filename to save SOA Form to with .HTML extension


Additional Inputs

Input Parameter Input Value Description
USPreferredCityNames True or False 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)
USStandardizationType Auto or Short or Long 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)
USAliasMode Convert or Preserve 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)
LastName [Text] Input LastName in which case the engine will try and append a missing suite from the address based on the last name. (US Only)


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=16460"