Global Email V3:Response: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
Created page with "← Global Email Web Service Reference {| class="mw-collapsible" cellspacing="2" style="background-color:#f9f9f9; border:1px solid #..."
 
No edit summary
 
(21 intermediate revisions by 2 users 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 response is the result of a request. This consists of returned results codes and parsed email elements.
 
Depending on the protocol used to make the request, the response will be in a certain protocol. Global Email supports the JSON, JSONP, SOAP, and XML protocols.
 
 
==Field Names==
This is a list of the response field names and their protocol naming conventions.
 
{| class="alternate01 sortable"
!Field Name !! Level !! JSON/XML
|-
|Version||rowspan="4" valign="center"|Response (Base)||Version
|-
|Transmission Reference||TransmissionReference
|-
|Transmission Results||TransmissionResults
|-
|Total Records||TotalRecords
|-
|Record ID||rowspan="8" valign="center"|Record||RecordID
|-
|Results||Results
|-
|Email Address||EmailAddress
|-
|Mailbox Name||MailboxName
|-
|Domain Name||DomainName
|-
|Top Level Domain||TopLevelDomain
|-
|Top Level Domain Name||TopLevelDomainName
|-
|Date Checked||DateChecked
|}
 
 
==Response Elements==
The following elements are the basic options for each request. These apply to the entire response, not the individual records.
 
<h3 style="background-color:rgb(240,240,240);">Version</h3>
:This is a string value that is the current revision number of Global Email.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Version":"'''''string'''''"</code>
|-
|SOAP/XML||<code><Version>'''''string'''''</Version></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Transmission Reference</h3>
:This is a string value that serves as a unique identifier for this set of records. It is returned as sent by the Request Array, allowing you to match the Response to the Request.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|
|JSON||<code>"TransmissionReference":"'''''string'''''"</code>
{| 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]]
|SOAP/XML||<code><TransmissionReference>'''''string'''''</TransmissionReference></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Transmission Results</h3>
:This is a string value that lists error codes from any errors caused by the most recent request as a whole.
 
:For a complete list of error codes, see [[Result Code Details#Global Email|Global Email Result Codes]].
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|[[Global Email Web Service:Licensing|Licensing]]
|JSON||<code>"TransmissionResults":"'''''string'''''"</code>
|-
|-
|[[Global Email Web Service:Result Code Use|Result Code Use]]
|SOAP/XML||<code><TransmissionResults>'''''string'''''</TransmissionResults></code>
|}
|}
<h3 style="background-color:rgb(240,240,240);">Total Records</h3>
:Displays the total number of records returned.
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|
|JSON||<code>"TotalRecords":"'''''string'''''"</code>
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|-
|- align="left"
|SOAP/XML||<code><TotalRecords>'''''string'''''</TotalRecords></code>
! style="color:black;"|[[Global Email Web Service:Request|Request]]
|}
 
 
==Response Record Elements==
JSON will only contain the Records element.
 
:{| class="alternate01"
!Protocol !! Definition
|-
|-
|[[Global Email Web Service:REST Request|REST]]
|JSON||Each record will be contained within [{}] under the Records element.
|-
|-
|[[Global Email Web Service:SOAP Request|SOAP]]
|SOAP||
|-
|-
|[[Global Email Web Service:XML/JSON Request|XML/JSON]]
|XML||
|}
|}
Each of the following elements are returned for each record in the Response Array.
<h3 style="background-color:rgb(240,240,240);">Record ID</h3>
:This is a string value that is a unique identifier for the current record if one was sent in the request. Use this element to match a request record and the corresponding response record.
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|
|JSON||<code>"RecordID":"'''''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><RecordID>'''''string'''''</RecordID></code>
|}
|}
<h3 style="background-color:rgb(240,240,240);">Results</h3>
:This is a string value with comma delimited status, error codes, and change codes for the record.
:For a complete list of codes, see [[Result Code Details#Global Email|Global Email Result Codes]].
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|
|JSON||<code>"Results":"'''''string'''''"</code>
{| class="mw-collapsible" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Email Web Service:Response|Response]]
|-
|-
|[[Global Email Web Service:XML Response|XML]]
|SOAP/XML||<code><Results>'''''string'''''</Results></code>
|}
|}
<h3 style="background-color:rgb(240,240,240);">Email Address</h3>
:This is a string value listing the email address, including any corrections or changes made by Global Email.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"EmailAddress":"'''''string'''''"</code>
|-
|-
|
|SOAP/XML||<code><EmailAddress>'''''string'''''</EmailAddress></code>
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|}
|- align="left"
 
! style="color:black;"|[[Global Email Web Service:Result Codes|Result Codes]]
 
<h3 style="background-color:rgb(240,240,240);">Mailbox Name</h3>
:This is a string value listing the mailbox or user name portion of the email address (All characters preceding the "@" character).
 
:With an example email of "sample@melissadata.com" the mailbox name would be "sample".
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|[[Returned Result Codes:APIs#Global Email Web Service|Returned Result Codes]]
|JSON||<code>"MailboxName":"'''''string'''''"</code>
|-
|-
|[[Global Email Web Service:Other Codes|Other Codes]]
|SOAP/XML||<code><MailboxName>'''''string'''''</MailboxName></code>
|}
|}
<h3 style="background-color:rgb(240,240,240);">Domain Name</h3>
:This is a string value listing the domain name portion of the email address (All characters between the "@" and "." characters).
:With an example email of "sample@melissadata.com" the domain name would be "melissadata".
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"DomainName":"'''''string'''''"</code>
|-
|-
|
|SOAP/XML||<code><DomainName>'''''string'''''</DomainName></code>
{| <!--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);">Top Level Domain</h3>
:This is a string value listing the description associated with the top-level domain name of the email address.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Top Level Domain":"'''''string'''''"</code>
|-
|SOAP/XML||<code><Top Level Domain>'''''string'''''</Top Level Domain></code>
|}
|}




{{CustomTOC}}
<h3 style="background-color:rgb(240,240,240);">Top Level Domain Name</h3>
:This is a string value listing the top level domain name portion of the email address (All characters after the ".").
 
:With an example email of "sample@melissadata.com" the top level domain name would be "com".
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TopLevelDomainName":"'''''string'''''"</code>
|-
|SOAP/XML||<code><TopLevelDomainName>'''''string'''''</TopLevelDomainName></code>
|}
 


==Sample JSON Response==
<h3 style="background-color:rgb(240,240,240);">Date Checked</h3>
<pre>
:This is a string value listing the date the email was last checked. DateChecked field returns a UTC, Unix Time (Epoch Time).
{
  "Version":"String content",
  "TransmissionReference":"String content",
  "TransmissionResults":"String content",
  "TotalRecords":"String content",
  "Records":[{
    "RecordID":"String content",
    "Results":"String content",
    "EmailAddress":"String content",
    "MailboxName":"String content",
    "DomainName":"String content",
    "TopLevelDomain":"String content",
    "TopLevelDomainName":"String content"
  }]
}
</pre>


==Sample XML Response==
:{| class="alternate01"
<pre>
!Protocol !! Syntax
<?xml version="1.0"?>
|-
<Response>
|JSON||<code>"DateChecked":"'''''string'''''"</code>
  <Version>string</Version>
|-
  <TransmissionReference>string</TransmissionReference>
|SOAP/XML||<code><DateChecked>'''''string'''''</DateChecked></code>
  < TransmissionResults>string</TransmissionResults>
|}
  <TotalRecords>string</TotalRecords>
  <Records>
    <ResponseRecord>
    <RecordID>string</RecordID>
    <Results>string</Results>
    <EmailAddress>string</EmailAddress>
    <MailboxName>string</MailboxName>
    <DomainName>string</DomainName>
    <TopLevelDomain>string</TopLevelDomain>
    <TopLevelDomainName>string</TopLevelDomainName>
  </ResponseRecord>
  </Records>
</Response>
</pre>




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

Latest revision as of 17:13, 23 May 2019

← 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 response is the result of a request. This consists of returned results codes and parsed email elements.

Depending on the protocol used to make the request, the response will be in a certain protocol. Global Email supports the JSON, JSONP, SOAP, and XML protocols.


Field Names

This is a list of the response field names and their protocol naming conventions.

Field Name Level JSON/XML
Version Response (Base) Version
Transmission Reference TransmissionReference
Transmission Results TransmissionResults
Total Records TotalRecords
Record ID Record RecordID
Results Results
Email Address EmailAddress
Mailbox Name MailboxName
Domain Name DomainName
Top Level Domain TopLevelDomain
Top Level Domain Name TopLevelDomainName
Date Checked DateChecked


Response Elements

The following elements are the basic options for each request. These apply to the entire response, not the individual records.

Version

This is a string value that is the current revision number of Global Email.
Protocol Syntax
JSON "Version":"string"
SOAP/XML <Version>string</Version>


Transmission Reference

This is a string value that serves as a unique identifier for this set of records. It is returned as sent by the Request Array, allowing you to match the Response to the Request.
Protocol Syntax
JSON "TransmissionReference":"string"
SOAP/XML <TransmissionReference>string</TransmissionReference>


Transmission Results

This is a string value that lists error codes from any errors caused by the most recent request as a whole.
For a complete list of error codes, see Global Email Result Codes.
Protocol Syntax
JSON "TransmissionResults":"string"
SOAP/XML <TransmissionResults>string</TransmissionResults>


Total Records

Displays the total number of records returned.
Protocol Syntax
JSON "TotalRecords":"string"
SOAP/XML <TotalRecords>string</TotalRecords>


Response Record Elements

JSON will only contain the Records element.

Protocol Definition
JSON Each record will be contained within [{}] under the Records element.
SOAP
XML

Each of the following elements are returned for each record in the Response Array.


Record ID

This is a string value that is a unique identifier for the current record if one was sent in the request. Use this element to match a request record and the corresponding response record.
Protocol Syntax
JSON "RecordID":"string"
SOAP/XML <RecordID>string</RecordID>


Results

This is a string value with comma delimited status, error codes, and change codes for the record.
For a complete list of codes, see Global Email Result Codes.
Protocol Syntax
JSON "Results":"string"
SOAP/XML <Results>string</Results>


Email Address

This is a string value listing the email address, including any corrections or changes made by Global Email.
Protocol Syntax
JSON "EmailAddress":"string"
SOAP/XML <EmailAddress>string</EmailAddress>


Mailbox Name

This is a string value listing the mailbox or user name portion of the email address (All characters preceding the "@" character).
With an example email of "sample@melissadata.com" the mailbox name would be "sample".
Protocol Syntax
JSON "MailboxName":"string"
SOAP/XML <MailboxName>string</MailboxName>


Domain Name

This is a string value listing the domain name portion of the email address (All characters between the "@" and "." characters).
With an example email of "sample@melissadata.com" the domain name would be "melissadata".
Protocol Syntax
JSON "DomainName":"string"
SOAP/XML <DomainName>string</DomainName>


Top Level Domain

This is a string value listing the description associated with the top-level domain name of the email address.
Protocol Syntax
JSON "Top Level Domain":"string"
SOAP/XML <Top Level Domain>string</Top Level Domain>


Top Level Domain Name

This is a string value listing the top level domain name portion of the email address (All characters after the ".").
With an example email of "sample@melissadata.com" the top level domain name would be "com".
Protocol Syntax
JSON "TopLevelDomainName":"string"
SOAP/XML <TopLevelDomainName>string</TopLevelDomainName>


Date Checked

This is a string value listing the date the email was last checked. DateChecked field returns a UTC, Unix Time (Epoch Time).
Protocol Syntax
JSON "DateChecked":"string"
SOAP/XML <DateChecked>string</DateChecked>
Retrieved from "http://wiki.melissadata.com/index.php?title=Global_Email_V3:Response&oldid=16510"