Global Address Verification:Request: Difference between revisions

Revision as of 20:56, 7 October 2016

Global Address Navigation

Introduction
Licensing

Input/Output
Request Fields
Response Fields

Examples
REST JSON
REST JSONP
REST XML
Batch JSON
Batch SOAP
Batch XML

Result Codes
Result Code Use
Global Address Verification Result Codes

Sample Code

A request consists of a protocol to make a call to the service, detailing desired elements. The minimum required elements in a request are your Customer ID and at least one address record.

Global Address Verification supports JSON, JSONP, REST, SOAP, and XML protocols.

Field Names

This is a list of the request field names and their protocol naming conventions.

Field Name	Level	REST	JSON/XML
Transmission Reference	Request	t	TransmissionReference
Customer ID		id	CustomerID
Options		opt	Options
Record ID	Record		RecordID
Organization		org	Organization
Address Line 1		a1	AddressLine1
Address Line 2		a2	AddressLine2
Address Line 3		a3	AddressLine3
Address Line 4		a4	AddressLine4
Address Line 5		a5	AddressLine5
Address Line 6		a6	AddressLine6
Address Line 7		a7	AddressLine7
Address Line 8		a8	AddressLine8
Double Dependent Locality		ddeploc	DoubleDependentLocality
Dependent Locality		deploc	DependentLocality
Locality		loc	Locality
Sub Administrative Area		subadmarea	SubAdministrativeArea
Administrative Area		admarea	AdministrativeArea
Postal Code		postal	PostalCode
Sub National Area		subnatarea	SubNationalArea
Country		ctry	Country
Format	Request	format	Format

Request Elements

The following elements set the basic options for each request. These apply to the entire request, not the individual records.

Transmission Reference

Optional.

This is a string value that serves as a unique identifier for this set of records. It is returned as sent.

Protocol	Syntax
JSON	`"TransmissionReference":"string"`
REST	`?t = string`
SOAP/XML	`<TransmissionReference>string</TransmissionReference>`

Customer ID

Required.

This is a string value containing the identification number issued to the customer by Melissa Data for Global Address Verification.

If this element is absent, the Web Service will return an error. To receive a customer ID, please contact your Melissa Data sales representative at 1-800-MELISSA.

Protocol	Syntax
JSON	`"CustomerID":"string"`
REST	`&id = string`
SOAP/XML	`<CustomerID>string</CustomerID>`

Options

Optional.

This is a string value containing the options set by the user.

Protocol	Syntax
JSON	`"Options":"string"`
REST	`?opt = string`
SOAP/XML	`<Options>string</Options>`

List options in the following format, with multiple options delimited with a ",".

Syntax
`OptionName:Parameter,OptionName:Parameter`

DeliveryLines

This options allows you to specify if the Address Lines 1-8 should contain just the delivery address or the entire address.

Option Name	Parameter	Description
DeliveryLines	`Off`	Default. Address Lines 1-8 return the entire address.
DeliveryLines	`On`	Address Lines 1-8 return just the street address and dependent locality. It will not contain locality, administrative area, postal code, etc.

LineSeparator

This is the line separator used for the FormattedAddress result.

Option Name	Parameter	Description
LineSeparator	`SEMICOLON`	Default. A semicolon (;).
	`PIPE`	A pipe (\|).
	`CR`	A carriage return.
	`LF`	A line feed.
	`CRLF`	A carriage return + line feed.
	`TAB`	A tab.
	`BR`	A line break.

OutputScript

This is the script type used for all applicable fields.

Option Name	Parameter	Description
OutputScript	`NOCHANGE`	Default. Returns the same script that is sent in.
	`LATN`	Returns in the Latin script.
	`NATIVE`	Returns in the native script for the designated country.

CountryOfOrigin

This is used to determine whether or not to include the country name as the last line in FormattedAddress.

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.

Request Record Elements

JSON will only contain the Records element.

Protocol	Definition
JSON	Each email will be contained within [{}] under the Records element.
REST	The REST interface only allows a single record per request.
SOAP	This element is an array of object variables of the type RequestRecords.
XML	There will be one RequestRecord element per address being submitted to the Cloud Service.

RecordID

Optional.

This is a string value containing a unique identifier for the current record. Use this to match the record submitted with the record returned. It will return the input.

Protocol	Syntax
JSON	`"RecordID":"string"`
SOAP/XML	`<RecordID>string</RecordID>`

Organization

Optional.

The organization name associated with the address record.

Protocol	Syntax
JSON	`"Organization":"string"`
REST	`&org = string`
SOAP/XML	`<Organization>string</Organization>`