MagnetMail Web Service Web Service

MagnetMail Web Service

Click here for a complete list of operations.

getTrackingData

Get Tracking Data

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /mmapi.asmx HTTP/1.1
Host: hlma-apie1.magnetmail.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.magnetmail.net/getTrackingData"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <mmAuthHeader xmlns="http://www.magnetmail.net/">
      <sessionId>string</sessionId>
      <user_id>string</user_id>
    </mmAuthHeader>
  </soap:Header>
  <soap:Body>
    <getTrackingData xmlns="http://www.magnetmail.net/">
      <user_id>string</user_id>
      <message_id>int</message_id>
      <group_id>int</group_id>
    </getTrackingData>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getTrackingDataResponse xmlns="http://www.magnetmail.net/">
      <getTrackingDataResult>
        <EmailSent>int</EmailSent>
        <EmailDelivered>int</EmailDelivered>
        <EmailOpened>int</EmailOpened>
        <EmailBounced>int</EmailBounced>
        <EmailLinksClicked>int</EmailLinksClicked>
        <WebLinksClicked>int</WebLinksClicked>
        <Unsubscribed>int</Unsubscribed>
        <FaxSent>int</FaxSent>
        <FaxDelivered>int</FaxDelivered>
        <FaxFailed>int</FaxFailed>
        <FTFNewEmails>int</FTFNewEmails>
        <FTF>int</FTF>
        <FTFSubscribers>int</FTFSubscribers>
        <GroupsEmailSentTo>
          <JobToGroup>
            <group_id>int</group_id>
            <group_name>string</group_name>
            <sent_date>dateTime</sent_date>
          </JobToGroup>
          <JobToGroup>
            <group_id>int</group_id>
            <group_name>string</group_name>
            <sent_date>dateTime</sent_date>
          </JobToGroup>
        </GroupsEmailSentTo>
        <GroupsFaxSentTo>
          <JobToGroup>
            <group_id>int</group_id>
            <group_name>string</group_name>
            <sent_date>dateTime</sent_date>
          </JobToGroup>
          <JobToGroup>
            <group_id>int</group_id>
            <group_name>string</group_name>
            <sent_date>dateTime</sent_date>
          </JobToGroup>
        </GroupsFaxSentTo>
      </getTrackingDataResult>
    </getTrackingDataResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /mmapi.asmx HTTP/1.1
Host: hlma-apie1.magnetmail.net
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <mmAuthHeader xmlns="http://www.magnetmail.net/">
      <sessionId>string</sessionId>
      <user_id>string</user_id>
    </mmAuthHeader>
  </soap12:Header>
  <soap12:Body>
    <getTrackingData xmlns="http://www.magnetmail.net/">
      <user_id>string</user_id>
      <message_id>int</message_id>
      <group_id>int</group_id>
    </getTrackingData>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getTrackingDataResponse xmlns="http://www.magnetmail.net/">
      <getTrackingDataResult>
        <EmailSent>int</EmailSent>
        <EmailDelivered>int</EmailDelivered>
        <EmailOpened>int</EmailOpened>
        <EmailBounced>int</EmailBounced>
        <EmailLinksClicked>int</EmailLinksClicked>
        <WebLinksClicked>int</WebLinksClicked>
        <Unsubscribed>int</Unsubscribed>
        <FaxSent>int</FaxSent>
        <FaxDelivered>int</FaxDelivered>
        <FaxFailed>int</FaxFailed>
        <FTFNewEmails>int</FTFNewEmails>
        <FTF>int</FTF>
        <FTFSubscribers>int</FTFSubscribers>
        <GroupsEmailSentTo>
          <JobToGroup>
            <group_id>int</group_id>
            <group_name>string</group_name>
            <sent_date>dateTime</sent_date>
          </JobToGroup>
          <JobToGroup>
            <group_id>int</group_id>
            <group_name>string</group_name>
            <sent_date>dateTime</sent_date>
          </JobToGroup>
        </GroupsEmailSentTo>
        <GroupsFaxSentTo>
          <JobToGroup>
            <group_id>int</group_id>
            <group_name>string</group_name>
            <sent_date>dateTime</sent_date>
          </JobToGroup>
          <JobToGroup>
            <group_id>int</group_id>
            <group_name>string</group_name>
            <sent_date>dateTime</sent_date>
          </JobToGroup>
        </GroupsFaxSentTo>
      </getTrackingDataResult>
    </getTrackingDataResponse>
  </soap12:Body>
</soap12:Envelope>