Global Email V3:Response: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 46: | Line 46: | ||
The following elements are the basic options for each request. These apply to the entire response, not the individual records. | The following elements are the basic options for each request. These apply to the entire response, not the individual records. | ||
<h3 style="background-color: | <h3 style="background-color:rgb(240,240,240);">Version</h3> | ||
:This is a string value that is the current revision number of Global Email. | :This is a string value that is the current revision number of Global Email. | ||
| Line 60: | Line 60: | ||
<h3 style="background-color: | <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. | :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. | ||
| Line 74: | Line 74: | ||
<h3 style="background-color: | <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. | :This is a string value that lists error codes from any errors caused by the most recent request as a whole. | ||
| Line 90: | Line 90: | ||
<h3 style="background-color: | <h3 style="background-color:rgb(240,240,240);">Total Records</h3> | ||
:Displays the total number of records returned. | :Displays the total number of records returned. | ||
| Line 120: | Line 120: | ||
<h3 style="background-color: | <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. | :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. | ||
| Line 134: | Line 134: | ||
<h3 style="background-color: | <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. | :This is a string value with comma delimited status, error codes, and change codes for the record. | ||
| Line 150: | Line 150: | ||
<h3 style="background-color: | <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. | :This is a string value listing the email address, including any corrections or changes made by Global Email. | ||
| Line 164: | Line 164: | ||
<h3 style="background-color: | <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). | :This is a string value listing the mailbox or user name portion of the email address (All characters preceding the "@" character). | ||
| Line 180: | Line 180: | ||
<h3 style="background-color: | <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). | :This is a string value listing the domain name portion of the email address (All characters between the "@" and "." characters). | ||
| Line 196: | Line 196: | ||
<h3 style="background-color: | <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. | :This is a string value listing the description associated with the top-level domain name of the email address. | ||
| Line 210: | Line 210: | ||
<h3 style="background-color: | <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 "."). | :This is a string value listing the top level domain name portion of the email address (All characters after the "."). | ||
| Line 226: | Line 226: | ||
<h3 style="background-color: | <h3 style="background-color:rgb(240,240,240);">Date Checked</h3> | ||
:This is a string value listing the date the email was last checked. | :This is a string value listing the date the email was last checked. | ||
Revision as of 22:35, 1 September 2016
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 |
|---|---|---|
| Version | Request | Version |
| Transmission Reference | Request | TransmissionReference |
| Transmission Results | Request | TransmissionResults |
| Total Records | Request | TotalRecords |
| Record ID | Record | RecordID |
| Results | Record | Results |
| Email Address | Record | EmailAddress |
| Mailbox Name | Record | MailboxName |
| Domain Name | Record | DomainName |
| Top Level Domain | Record | TopLevelDomain |
| Top Level Domain Name | Record | TopLevelDomainName |
| Date Checked | Record | 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, JSONP “Version”:”string” SOAP <urn:Version>?</urn:Version> 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, JSONP “TransmissionReference”:”string” SOAP <urn:TransmissionReference>?</urn:TransmissionReference> 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, JSONP “TransmissionResults”:”string” SOAP <urn:TransmissionResults>?</urn:TransmissionResults> XML <TransmissionResults>string</TransmissionResults>
Total Records
- Displays the total number of records returned.
Protocol Syntax JSON, JSONP “TotalRecords”:”string” SOAP <urn:TotalRecords>?</urn:TotalRecords> XML <TotalRecords>string</TotalRecords>
Response Record Elements
JSON will only contain the Records element.
Protocol Definition JSON, JSONP 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, JSONP “RecordID”:”string” SOAP <urn:RecordID>?</urn:RecordID> 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, JSONP “Results”:”string” SOAP <urn:Results>?</urn:Results> 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, JSONP “EmailAddress”:”string” SOAP <urn:EmailAddress>?</urn:EmailAddress> 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, JSONP “MailboxName”:”string” SOAP <urn:MailboxName>?</urn:MailboxName> 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, JSONP “DomainName”:”string” SOAP <urn:DomainName>?</urn:DomainName> 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, JSONP “Top Level Domain”:”string” SOAP <urn:Top Level Domain>?</urn:Top Level Domain> 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, JSONP “TopLevelDomainName”:”string” SOAP <urn:TopLevelDomainName>?</urn:TopLevelDomainName> XML <TopLevelDomainName>string</TopLevelDomainName>
Date Checked
- This is a string value listing the date the email was last checked.
Protocol Syntax JSON, JSONP “DateChecked”:”string” SOAP <urn:DateChecked>?</urn:DateChecked> XML <DateChecked>string</DateChecked>