Global Email V3:Request

From Melissa Data Wiki
Revision as of 20:09, 26 August 2016 by Admin (talk | contribs)
Jump to navigation Jump to search

Template:GlobalEmailNav



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 input email address.

Global Email 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 Abbreviation JSON
Transmission Reference Request t TransmissionReference
Customer ID Request id CustomerID
Options Request opt Options
Record ID Record RecordID
Email Record email Email
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, JSONP “TransmissionReference”:”string"
REST ?t = {string}
SOAP <urn:TransmissionReference>?</urn:TransmissionReference>
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 Email.
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}


Options

Optional.
This is a string value containing the options set by the user.
Protocol Syntax
JSON "Options”:”string”
REST ?opt = {string}



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.


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 what is inputted.
Protocol Syntax
JSON “RecordID”:”string”


Email

Required.
The email to be verified
Protocol Syntax
JSON “Email”:”string”
REST &email = {string}


Format

Optional.
The desired format of the response.
Protocol Syntax
JSON “Format”:”string”
REST &format = {string}