Global Email V3:Request: Difference between revisions

Latest revision as of 21:36, 18 March 2020

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	Record	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.
VerifyMailBox	`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.
DomainCorrection	`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>`

Global Email V3:Request: Difference between revisions

Latest revision as of 21:36, 18 March 2020

Contents

URL

SOAP

REST, XML, JSON, etc.

Field Names

Request Elements

Transmission Reference

License Key

Options

VerifyMailBox

DomainCorrection

TimeToWait

Format

Request Record Elements

RecordID

Email

Navigation menu

@@ Line 1: / Line 1: @@
-{{GlobalEmailNav
+{{GlobalEmailV3Nav
-|RequestCollapse=
+|InputOutputCollapse=
 }}
@@ Line 6: / Line 6: @@
 {{CustomTOC}}
-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]].
+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.
-==Request Properties==
+Global Email supports JSON, JSONP, REST, SOAP, and XML protocols.
-===Required===
-;CustomerID
-:The Customer ID is your license string. This must be valid for you to access the web service.
-;Email
-:Input email to be validated.
-===Optional===
+==URL==
-;RecordID
+{{URL-GlobalEmailV3}}
-:Unique record ID, if processing mutliple records.
-;TransmissionReference
-:A unique string value identifying the request.
-;[[Global Email Web Service:Options|Options]]
+==Field Names==
-:[[Global Email Web Service:Options#VerifyMailBox|VerifyMailBox]].
+This is a list of the request field names and their protocol naming conventions.
-:For more information, please see [[Global Email Web Service:Options|options]].
+{| class="alternate01 sortable"
+!Field Name !! Level !! REST !! JSON
+|-
+|Transmission Reference||rowspan="4" valign="center"|Request||t||TransmissionReference
+|-
+|License Key||id||CustomerID
+|-
+|Options||opt||Options
+|-
+|Format||format||Format
+|-
+|Record ID||rowspan="2" valign="center"|Record|| ||RecordID
+|-
+|Email||email||Email
+|}
-[[Category:Global 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
+|-
+|JSON||<code>"TransmissionReference":"'''''string'''''"</code>
+|-
+|REST||<code>?t = '''''string'''''</code>
+|-
+|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>
+|-
+|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>
+|-
+|SOAP/XML||<code><Options>'''''string'''''</Options></code>
+|}
+:List options in the following format, with multiple options delimited with a ",".
+:{| class="alternate01"
+!Syntax
+|-
+|<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.
+|-
+|<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
+|-
+|rowspan="2"|'''DomainCorrection'''||<code>On</code>||'''''Default.''''' Activates fuzzy email domain correction if the domain is a suspected typo.
+|-
+|<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.
+|}
+<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>
+|}
+==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.
+|}
+<h3 style="background-color:rgb(240,240,240);">RecordID</h3>
+:''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.
+:{| class="alternate01"
+!Protocol !! Syntax
+|-
+|JSON||<code>"RecordID":"'''''string'''''"</code>
+|-
+|SOAP/XML||<code><RecordID>'''''string'''''</RecordID></code>
+|}
+<h3 style="background-color:rgb(240,240,240);">Email</h3>
+:''Required.''
+:The email to be verified
+:{| class="alternate01"
+!Protocol !! Syntax
+|-
+|JSON||<code>"Email":"'''''string'''''"</code>
+|-
+|REST||<code>&email = '''''string'''''</code>
+|-
+|SOAP/XML||<code><Email>'''''string'''''</Email></code>
+|}
+[[Category:Global Email V3]]
 [[Category:Reference]]

Global Email V3:Request: Difference between revisions

Latest revision as of 21:36, 18 March 2020

URL

SOAP

REST, XML, JSON, etc.

Field Names

Request Elements

Transmission Reference

License Key

Options

VerifyMailBox

DomainCorrection

TimeToWait

Format

Request Record Elements

RecordID

Email

Navigation menu

Search