Global Email V3:Response
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 | 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 "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.
Protocol Syntax JSON "DateChecked":"string"SOAP/XML <DateChecked>string</DateChecked>