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

From Melissa Data Wiki
Jump to navigation Jump to search
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;"
}}
! style="text-align:left; color:black; border-bottom:1px solid #aaaaaa;"|'''Global Address Object Navigation'''
|-
| style="padding-right:220px;"|
|-
|
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Address Object:Introduction|Introduction]]
|-
|[[Global Address Object:Platforms and Methods|Platforms and Methods]]
|-
|[[Global Address Object:Licensing|Licensing]]
|}
|-
|
{| 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]]
|}
|-
|
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Address Object:Methods|Methods]]
|-
|[[Global Address Object:Setup Methods|Setup Methods]]
|-
|[[Global Address Object:Input Methods|Input Methods]]
|-
|[[Global Address Object:Processing Methods|Processing Methods]]
|-
|[[Global Address Object:Output Methods|Output Methods]]
|}
|-
|
{| class="mw-collapsible" style="width:100%;"
|- align="left"
! style="color:black;"|Parameters
|-
|[[Global Address Object:Input Parameters|Input Parameters]]
|-
|[[Global Address Object:Output Parameters|Output Parameters]]
|}
|-
|
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Address Object:Result Codes|Result Codes]]
|-
|[[Returned Result Codes:APIs#Global Address Object|Returned Result Codes]]
|-
|[[Global Address Object:Other Codes|Other Codes]]
|}
|}
 


{{CustomTOC}}
{{CustomTOC}}

Revision as of 17:48, 23 July 2015

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

outputPreference

Determine the script of the output, two possible values "native" and "latin." Native tells the object to return the output in the native script i.e. cyrillic for Russia. Latin transliterates the output to latin characters.

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

Business or Company.

inputAddressLine1

Address lines should include, at minimum, the delivery address. It can also contain the full address if you do not have the area information (locality, administrative area, postal code) parsed into their individual fields.

inputAddressLine2

inputAddressLine3

inputAddressLine4

inputAddressLine5

inputAddressLine6

inputAddressLine7

inputAddressLine8

inputSubPremises

Suite. Alphanumeric code identifying an individual location.

inputDoubleDependentLocality

Smallest population center data element.

inputDependentLocality

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

inputLocality

City. Most common population center data element.

inputSubAdministrativeArea

County. Smallest geographic data element.

inputAdministrativeArea

State. Most common geographic data element.

inputSubNationalArea

Arbitrary administrative region below that of the sovereign state.

inputPostalCode

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.