Global Email V3:Request: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 81: | Line 81: | ||
|} | |} | ||
:List options in the following format, with multiple options delimited with a ",". | |||
:< | :<pre><OptionName>:<Parameter>,<OptionName>:<Parameter></pre> | ||
:: | |||
:<h4 style="border-bottom:1px solid black;">VerifyMailBox</h4> | |||
::VerifyMailBox validates email mailbox. | |||
::{| class="alternate01 sortable" | |||
!Option Name !! Parameter !! Description | |||
|- | |||
|rowspan="2"|'''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. | |||
|} | |||
:<h4 style="border-bottom:1px solid black;">DaysSinceLastVerified</h4> | |||
::'''Advanced Option for Premium Mode'''. DaysSinceLastVerified sets the freshness of the data returning. | |||
::{| class="alternate01 sortable" | |||
!Option Name !! Parameter !! Description | |||
|- | |||
|rowspan="2"|'''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. | |||
|} | |||
:<h4 style="border-bottom:1px solid black;">DomainCorrection</h4> | |||
::DomainCorrection turns on fuzzy correction on suspected email domains typos. | |||
::{| class="alternate01 sortable" | |||
!Option Name !! Parameter !! Description | |||
|- | |||
|rowspan="2"|'''DomainCorrection'''||On||'''''Default.''''' Activates fuzzy email domain correction if the domain is a suspected typo. | |||
|- | |||
|Off||No email domain correction. | |||
|} | |||
Revision as of 23:26, 26 August 2016
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 | |
Record | |||
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}
- 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 | 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”
- 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}