Difference between revisions of "Global Email V3:Request"

From Melissa Data Wiki
Jump to navigation Jump to search
Line 1: Line 1:
{{GlobalEmailNav
{{GlobalEmailNav
|RequestCollapse=
|InputOutputCollapse=
}}
}}


Line 6: Line 6:
{{CustomTOC}}
{{CustomTOC}}


Global Email 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 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===
==Field Names==
;RecordID
This is a list of the request field names and their protocol naming conventions.
:Unique record ID, if processing mutliple records.


;TransmissionReference
{| class="alternate01 sortable"
:A unique string value identifying the request.
!Field Name !! Level !! REST Abbreviation !! JSON
|- style="vertical-align:top;"
|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
|}


;[[Global Email Web Service:Options|Options]]
:[[Global Email Web Service:Options#VerifyMailBox|VerifyMailBox]].


:For more information, please see [[Global Email Web Service:Options|options]].
==Request Elements==
The following elements set the basic options for each request. These apply to the entire request, not the individual records.


;Format
<h3 style="background-color:rgb(240,240,240);">Transmission Reference</h3>
:Choose between XML or JSON formatted response.
:''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, JSONP||“TransmissionReference”:”string"
|-
|REST||?t = {string}
|-
|SOAP||<nowiki><urn:TransmissionReference>?</urn:TransmissionReference></nowiki>
|-
|XML||<TransmissionReference>string</TransmissionReference>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Customer ID</h3>
:''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.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||"CustomerID”:”string”
|-
|REST||&id = {string}
|}
 
 
<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||"Options”:”string”
|-
|REST||?opt = {string}
|}
 
 
:<h4 style="border-bottom:1px solid black;"></h4>
::
 
::
 
 
==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.
|}
 
 
<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||“RecordID”:”string”
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Email</h3>
:''Required.''
 
:The email to be verified
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||“Email”:”string”
|-
|REST||&email = {string}
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Format</h3>
:''Optional.''
 
:The desired format of the response.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||“Format”:”string”
|-
|REST||&format = {string}
|}




[[Category:Global Email]]
[[Category:Global Email]]
[[Category:Reference]]
[[Category:Reference]]

Revision as of 20:09, 26 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 "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}



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”


Email

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