Difference between revisions of "Global Email V3:Request"

From Melissa Data Wiki
Jump to navigation Jump to search
Line 62: Line 62:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"CustomerID”:”string”
|JSON, JSONP||"CustomerID”:”string”
|-
|-
|REST||&id = {string}
|REST||&id = {string}
|-
|SOAP||<nowiki><urn:CustomerID>?</urn:CustomerID></nowiki>
|-
|XML||<CustomerID>string</CustomerID>
|}
|}


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


Line 132: Line 140:
!Protocol !! Definition
!Protocol !! Definition
|-
|-
|JSON||Each email will be contained within [{}] under the Records element.
|JSON, JSONP||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||
|-
|XML||
|}
|}


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


Line 172: Line 188:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||“Format”:”string”
|JSON, JSONP||“Format”:”string”
|-
|-
|REST||&format = {string}
|REST||&format = {string}
|-
|SOAP||<nowiki><urn:Format>?</urn:Format></nowiki>
|-
|XML||<Format>string</Format>
|}
|}


Revision as of 21:37, 29 August 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 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, JSONP "CustomerID”:”string”
REST &id = {string}
SOAP <urn:CustomerID>?</urn:CustomerID>
XML <CustomerID>string</CustomerID>


Options

Optional.
This is a string value containing the options set by the user.
Protocol Syntax
JSON, JSONP "Options”:”string”
REST ?opt = {string}
SOAP <urn:Options>?</urn:Options>
XML <Options>string</Options>
List options in the following format, with multiple options delimited with a ",".
<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.


DaysSinceLastVerified

Advanced Option for Premium Mode. DaysSinceLastVerified sets the freshness of the data returning.
Option Name Parameter Description
DaysSinceLastVerified 3 Default.
3-365 You can set how fresh the data you want. By setting a higher value, you will receive faster responses but the data will not be as fresh.

You can set this value from 3 to 365 days.

This option is for premium mode only. Our result code ES21 will let you know that it is a cache lookup and ES22 will let you know that the validation was performed in realtime.


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, JSONP Each email will be contained within [{}] under the Records element.
REST The REST interface only allows a single record per request.
SOAP
XML


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, JSONP “Email”:”string”
REST &email = {string}
SOAP <urn:Email>?</urn:Email>
XML <Email>string</Email>


Format

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