Difference between revisions of "Global Email V3:Request"

From Melissa Data Wiki
Jump to navigation Jump to search
Line 15: Line 15:


{| class="alternate01 sortable"
{| class="alternate01 sortable"
!Field Name !! Level !! REST Abbreviation !! JSON
!Field Name !! Level !! REST !! JSON
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|Transmission Reference||Request||t||TransmissionReference
|Transmission Reference||Request||t||TransmissionReference
Line 42: Line 42:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON, JSONP||“TransmissionReference”:”string"
|JSON||<code>"TransmissionReference":"'''''string'''''"</code>
|-
|-
|REST||?t = {string}
|REST||<code>?t = '''''string'''''</code>
|-
|-
|SOAP||<urn:TransmissionReference>?</urn:TransmissionReference>
|SOAP/XML||<code><TransmissionReference>'''''string'''''</TransmissionReference></code>
|-
|XML||<TransmissionReference>string</TransmissionReference>
|}
|}


Line 62: Line 60:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON, JSONP||"CustomerID”:”string”
|JSON||<code>"CustomerID":"'''''string'''''"</code>
|-
|-
|REST||&id = {string}
|REST||<code>&id = '''''string'''''</code>
|-
|-
|SOAP||<urn:CustomerID>?</urn:CustomerID>
|SOAP/XML||<code><CustomerID>'''''string'''''</CustomerID></code>
|-
|XML||<CustomerID>string</CustomerID>
|}
|}


Line 80: Line 76:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON, JSONP||"Options”:”string”
|JSON||<code>"Options":"'''''string'''''"</code>
|-
|-
|REST||?opt = {string}
|REST||<code>?opt = '''''string'''''</code>
|-
|-
|SOAP||<urn:Options>?</urn:Options>
|SOAP/XML||<code><Options>'''''string'''''</Options></code>
|-
|XML||<Options>string</Options>
|}
|}


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


:<pre><OptionName>:<Parameter>,<OptionName>:<Parameter></pre>
:{| class="alternate01"
!Syntax
|-
|<code>''OptionName'':''Parameter'',''OptionName'':''Parameter''</code>
|}




Line 100: Line 99:
!Option Name !! Parameter !! Description
!Option Name !! Parameter !! Description
|-
|-
|rowspan="2"|'''VerifyMailBox'''||Express||'''''Default.''''' Also known as fast mode. Quickly validates against database of known email addresses.
|rowspan="2"|'''VerifyMailBox'''||<code>Express</code>||'''''Default.''''' Also known as fast mode. Quickly validates against database of known email addresses.
|-
|-
|Premium||Also known as real time mode. Perform real time, live validation of email addresses.
|<code>Premium</code>||Also known as real time mode. Perform real time, live validation of email addresses.
|}
|}


Line 112: Line 111:
!Option Name !! Parameter !! Description
!Option Name !! Parameter !! Description
|-
|-
|rowspan="2"|'''DomainCorrection'''||On||'''''Default.''''' Activates fuzzy email domain correction if the domain is a suspected typo.
|rowspan="2"|'''DomainCorrection'''||<code>On</code>||'''''Default.''''' Activates fuzzy email domain correction if the domain is a suspected typo.
|-
|-
|Off||No email domain correction.
|<code>Off</code>||No email domain correction.
|}
|}


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


Line 142: Line 141:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||“RecordID”:”string”
|JSON||<code>"RecordID":"'''''string'''''"</code>
|-
|-
|SOAP||<urn:RecordID>?</urn:RecordID>
|SOAP/XML||<code><RecordID>'''''string'''''</RecordID></code>
|-
|XML||<RecordID>string</RecordID>
|}
|}


Line 158: Line 155:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON, JSONP||“Email”:”string”
|JSON||<code>"Email":"'''''string'''''"</code>
|-
|-
|REST||&email = {string}
|REST||<code>&email = '''''string'''''</code>
|-
|-
|SOAP||<urn:Email>?</urn:Email>
|SOAP/XML||<code><Email>'''''string'''''</Email></code>
|-
|XML||<Email>string</Email>
|}
|}


Line 176: Line 171:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON, JSONP||“Format”:”string”
|JSON||<code>"Format":"'''''string'''''"</code>
|-
|REST||&format = {string}
|-
|-
|SOAP||<urn:Format>?</urn:Format>
|REST||<code>&format = '''''string'''''</code>
|-
|-
|XML||<Format>string</Format>
|SOAP/XML||<code><Format>'''''string'''''</Format></code>
|}
|}


Revision as of 19:49, 6 October 2016

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


VerifyMailBox

VerifyMailBox validates email mailbox.
Option Name Parameter Description
VerifyMailBox Express Default. Also known as fast mode. Quickly validates against database of known email addresses.
Premium Also known as real time mode. Perform real time, live validation of email addresses.


DomainCorrection

DomainCorrection turns on fuzzy correction on suspected email domains typos.
Option Name Parameter Description
DomainCorrection On Default. Activates fuzzy email domain correction if the domain is a suspected typo.
Off No email domain correction.


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 what is inputted.
Protocol Syntax
JSON "RecordID":"string"
SOAP/XML <RecordID>string</RecordID>


Email

Required.
The email to be verified
Protocol Syntax
JSON "Email":"string"
REST &email = string
SOAP/XML <Email>string</Email>


Format

Optional.
The desired format of the response.
Protocol Syntax
JSON "Format":"string"
REST &format = string
SOAP/XML <Format>string</Format>
Retrieved from "http://wiki.melissadata.com/index.php?title=Global_Email_V3:Request&oldid=11714"