Global Email V3:Request: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
← Older edit
No edit summary
No edit summary
 
(25 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Global Email Web Service:Reference|← Global Email Web Service Reference]]
{{GlobalEmailV3Nav
|InputOutputCollapse=
}}


{| class="mw-collapsible" cellspacing="2" style="background-color:#f9f9f9; border:1px solid #aaaaaa; font-size:9pt; color:#0645ad; padding:8px 8px;"
 
! style="text-align:left; color:black; border-bottom:1px solid #aaaaaa;"|'''Global Email Web Service Navigation'''
{{CustomTOC}}
|-  
 
| style="padding-right:220px;"|
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 (License Key) and at least one input email address.
 
Global Email supports JSON, JSONP, REST, SOAP, and XML protocols.
 
 
==URL==
{{URL-GlobalEmailV3}}
 
 
==Field Names==
This is a list of the request field names and their protocol naming conventions.
 
{| class="alternate01 sortable"
!Field Name !! Level !! REST !! JSON
|-
|Transmission Reference||rowspan="4" valign="center"|Request||t||TransmissionReference
|-
|-
|
|License Key||id||CustomerID
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Email Web Service:Introduction|Introduction]]
|-
|-
|[[Global Email Web Service:Functions and Capabilities|Functions and Capabilities]]
|Options||opt||Options
|-
|-
|[[Global Email Web Service:Licensing|Licensing]]
|Format||format||Format
|}
|-
|-
|
|Record ID||rowspan="2" valign="center"|Record|| ||RecordID
{| class="mw-collapsible" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Email Web Service:Request|Request]]
|-
|-
|[[Global Email Web Service:REST Request|REST]]
|Email||email||Email
|}
 
 
==Request Elements==
The following elements set the basic options for each request. These apply to the entire request, not the individual records.
 
<h3 style="background-color:rgb(240,240,240);">Transmission Reference</h3>
:''Optional.''
 
:This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|[[Global Email Web Service:SOAP Request|SOAP]]
|JSON||<code>"TransmissionReference":"'''''string'''''"</code>
|-
|-
|[[Global Email Web Service:JSON Request|JSON]]
|REST||<code>?t = '''''string'''''</code>
|-
|-
|[[Global Email Web Service:XML Request|XML]]
|SOAP/XML||<code><TransmissionReference>'''''string'''''</TransmissionReference></code>
|}
|}
<h3 style="background-color:rgb(240,240,240);">License Key</h3>
:''Required.''
:This is a string value containing the License Key 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 License Key, please contact your Melissa Data sales representative at 1-800-MELISSA.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"CustomerID":"'''''string'''''"</code>
|-
|-
|
|REST||<code>&id = '''''string'''''</code>
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Email Web Service:Options|Options]]
|-
|-
|[[Global Email Web Service:Options#VerifyMailBox|VerifyMailBox]]
|SOAP/XML||<code><CustomerID>'''''string'''''</CustomerID></code>
|}
|}
<h3 style="background-color:rgb(240,240,240);">Options</h3>
:''Optional.''
:This is a string value containing the options set by the user.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Options":"'''''string'''''"</code>
|-
|-
|
|REST||<code>?opt = '''''string'''''</code>
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Email Web Service:Response|Response]]
|-
|-
|[[Global Email Web Service:JSON Response|JSON]]
|SOAP/XML||<code><Options>'''''string'''''</Options></code>
|}
 
 
:List options in the following format, with multiple options delimited with a ",".
 
:{| class="alternate01"
!Syntax
|-
|-
|[[Global Email Web Service:XML Response|XML]]
|<code>''OptionName'':''Parameter'',''OptionName'':''Parameter''</code>
|}
|}
:<h4 style="border-bottom:1px solid black;">VerifyMailBox</h4>
::Validates email mailbox.
::{| class="alternate01 sortable"
!Option Name !! Parameter !! Description
|-
|-
|
|rowspan="2"|'''VerifyMailBox'''||<code>Express</code>||'''''Default.''''' Quickly validates against database of known email addresses.
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Email Web Service:Result Codes|Result Codes]]
|-
|-
|[[Global Email Web Service:Result Code Use|Result Code Use]]
|<code>Premium</code>||A real time check is performed to determine email deliverability.
|}
 
 
:<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
|-
|-
|[[Returned Result Codes:APIs#Global Email Web Service|Returned Result Codes]]
|rowspan="2"|'''DomainCorrection'''||<code>On</code>||'''''Default.''''' Activates fuzzy email domain correction if the domain is a suspected typo.
|-
|-
|[[Global Email Web Service:Other Codes|Other Codes]]
|<code>Off</code>||No email domain correction.
|}
|}
:<h4 style="border-bottom:1px solid black;">TimeToWait</h4>
::TimeToWait allows you to select how long (in seconds) that you would like our web service to wait on a single email before it times out. Select a smaller number if time is of essence, or longer if you would prefer more accurate results.
::{| class="alternate01 sortable"
!Option Name !! Parameter !! Description
|-
|-
|
|'''TimeToWait'''||<code># [5 - 45]</code>||'''''Default set to 25.''''' Select how long the web service will wait before it times out on an email.
{| <!--class="mw-collapsible mw-collapsed"--> style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Email Web Service:Sample Code|Sample Code]]
|}
|}
<h3 style="background-color:rgb(240,240,240);">Format</h3>
:''Optional.''
:The desired format of the response.
:{| class="alternate01"
!Protocol !! Syntax
|-
|REST||<code>&format = '''''string'''''</code>
|-
|JSON (HTTP Header)||<code>Accept: application/json</code>
|-
|SOAP/XML (HTTP Header)||<code>Accept: application/xml</code>
|}
|}




{{CustomTOC}}
==Request Record Elements==
JSON will only contain the Records element.
 
{| class="alternate01"
!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.
|}
 


The Global Email Web Service can make requests in [[Global Email Web Service:REST Request|REST]], [[Global Email Web Service:SOAP Request|SOAP]], [[Global Email Web Service:JSON Request|JSON]], and [[Global Email Web Service:XML Request|XML]].
<h3 style="background-color:rgb(240,240,240);">RecordID</h3>
:''Optional.''


==Request Properties==
: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.
===Required===
;CustomerID
:The Customer ID is your license string. This must be valid for you to access the Web
service.


;Email
:{| class="alternate01"
:Input email to be validated.
!Protocol !! Syntax
|-
|JSON||<code>"RecordID":"'''''string'''''"</code>
|-
|SOAP/XML||<code><RecordID>'''''string'''''</RecordID></code>
|}


===Optional===
;RecordID
:Unique record ID, if processing mutliple records.


;TransmissionReference
<h3 style="background-color:rgb(240,240,240);">Email</h3>
:A unique string value identifying the request.
:''Required.''


;[[Global Email Web Service:Options|Options]]
:The email to be verified
:[[Global Email Web Service:Options#VerifyMailBox|VerifyMailBox]].


:For more information, please see [[Global Email Web Service:Options|options]].
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Email":"'''''string'''''"</code>
|-
|REST||<code>&email = '''''string'''''</code>
|-
|SOAP/XML||<code><Email>'''''string'''''</Email></code>
|}




[[Category:Global Email Web Service]]
[[Category:Global Email V3]]
[[Category:Reference]]
[[Category:Reference]]

Latest revision as of 21:36, 18 March 2020

← Global Email V3

Global Email V3 Navigation
Introduction
Licensing
Input/Output
Request Fields
Response Fields
Examples
REST JSON
REST JSONP
REST XML
Batch SOAP
Batch XML
Result Codes
Result Code Use
Global Email V3 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 (License Key) and at least one input email address.

Global Email supports JSON, JSONP, REST, SOAP, and XML protocols.


URL

SOAP

Use URL
Standard http://globalemail.melissadata.net/v3/SOAP/globalemail
Secure https://globalemail.melissadata.net/v3/SOAP/globalemail


REST, XML, JSON, etc.

Use URL
Standard http://globalemail.melissadata.net/v3/WEB/GlobalEmail/doGlobalEmail
Secure https://globalemail.melissadata.net/v3/WEB/GlobalEmail/doGlobalEmail


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
License Key id CustomerID
Options opt Options
Format format Format
Record ID Record RecordID
Email email Email


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>


License Key

Required.
This is a string value containing the License Key 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 License Key, 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

Validates email mailbox.
Option Name Parameter Description
VerifyMailBox Express Default. Quickly validates against database of known email addresses.
Premium A real time check is performed to determine email deliverability.


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.


TimeToWait

TimeToWait allows you to select how long (in seconds) that you would like our web service to wait on a single email before it times out. Select a smaller number if time is of essence, or longer if you would prefer more accurate results.
Option Name Parameter Description
TimeToWait # [5 - 45] Default set to 25. Select how long the web service will wait before it times out on an email.


Format

Optional.
The desired format of the response.
Protocol Syntax
REST &format = string
JSON (HTTP Header) Accept: application/json
SOAP/XML (HTTP Header) Accept: application/xml


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>
Retrieved from "http://wiki.melissadata.com/index.php?title=Global_Email_V3:Request&oldid=17076"