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

From Melissa Data Wiki
Jump to navigation Jump to search
Line 45: Line 45:
{| class="mw-collapsible" style="width:100%;"
{| class="mw-collapsible" style="width:100%;"
|- align="left"
|- align="left"
! style="color:black;"|[[Global Address Object:Parameters|Parameters]]
! style="color:black;"|Parameters
|-
|-
|[[Global Address Object:Input Parameters|Input Parameters]]
|[[Global Address Object:Input Parameters|Input Parameters]]
Line 72: Line 72:
==Processing Configuration Parameters==
==Processing Configuration Parameters==
===countryOfOrigin===
===countryOfOrigin===
The country from which the input file originated from.
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===
===inputFormattedAddressSeparator===
This parameter collates all address lines into a single string with the defined '''lineSeparator''' as a delimiter.
This is a string used to delimit line in the FormattedAddress output field. This string can be one or multiple characters.





Revision as of 18:59, 21 October 2014

← Global Address Object Reference

Global Address Object Navigation
Introduction
Platforms and Methods
Licensing
Result Code Use
Interface
Address Handling
Interface Use
Methods
Setup Methods
Input Methods
Processing Methods
Output Methods
Parameters
Input Parameters
Output Parameters
Result Codes
Returned 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.