MagnetMail Web Service


Click here for a complete list of operations.

getDetailedTrackingUTC

Get detailed tracking data for a message. UTC Times returned for dates

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/getDetailedTrackingUTC"

<?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>
    <getDetailedTrackingUTC xmlns="http://www.magnetmail.net/">
      <user_id>string</user_id>
      <report_type>email_sent or email_delivered or email_bounced or email_opened or unsubscribed or fax_sent or fax_delivered or fax_failed or links or all or fax_all</report_type>
      <message_id>int</message_id>
      <page>int</page>
      <recordsPerPage>int</recordsPerPage>
      <group_id>int</group_id>
      <first_name>string</first_name>
      <last_name>string</last_name>
      <email>string</email>
      <fax>string</fax>
      <fromDate>dateTime</fromDate>
      <toDate>dateTime</toDate>
      <CustomParam1>string</CustomParam1>
    </getDetailedTrackingUTC>
  </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>
    <getDetailedTrackingUTCResponse xmlns="http://www.magnetmail.net/">
      <getDetailedTrackingUTCResult>
        <totalRecords>int</totalRecords>
        <page>int</page>
        <recordsPerPage>int</recordsPerPage>
        <RecipientDetails>
          <recp_track>
            <recipient xsi:nil="true" />
            <ResultDate>dateTime</ResultDate>
            <remarks>string</remarks>
            <Status>Inprogress or Delivered or SB or HB or UNF or TU or MF or BD or Failed</Status>
            <OpenDate>dateTime</OpenDate>
            <MMId>long</MMId>
            <faxStatus>Inprogress or Delivered or Failed</faxStatus>
          </recp_track>
          <recp_track>
            <recipient xsi:nil="true" />
            <ResultDate>dateTime</ResultDate>
            <remarks>string</remarks>
            <Status>Inprogress or Delivered or SB or HB or UNF or TU or MF or BD or Failed</Status>
            <OpenDate>dateTime</OpenDate>
            <MMId>long</MMId>
            <faxStatus>Inprogress or Delivered or Failed</faxStatus>
          </recp_track>
        </RecipientDetails>
      </getDetailedTrackingUTCResult>
    </getDetailedTrackingUTCResponse>
  </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>
    <getDetailedTrackingUTC xmlns="http://www.magnetmail.net/">
      <user_id>string</user_id>
      <report_type>email_sent or email_delivered or email_bounced or email_opened or unsubscribed or fax_sent or fax_delivered or fax_failed or links or all or fax_all</report_type>
      <message_id>int</message_id>
      <page>int</page>
      <recordsPerPage>int</recordsPerPage>
      <group_id>int</group_id>
      <first_name>string</first_name>
      <last_name>string</last_name>
      <email>string</email>
      <fax>string</fax>
      <fromDate>dateTime</fromDate>
      <toDate>dateTime</toDate>
      <CustomParam1>string</CustomParam1>
    </getDetailedTrackingUTC>
  </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>
    <getDetailedTrackingUTCResponse xmlns="http://www.magnetmail.net/">
      <getDetailedTrackingUTCResult>
        <totalRecords>int</totalRecords>
        <page>int</page>
        <recordsPerPage>int</recordsPerPage>
        <RecipientDetails>
          <recp_track>
            <recipient xsi:nil="true" />
            <ResultDate>dateTime</ResultDate>
            <remarks>string</remarks>
            <Status>Inprogress or Delivered or SB or HB or UNF or TU or MF or BD or Failed</Status>
            <OpenDate>dateTime</OpenDate>
            <MMId>long</MMId>
            <faxStatus>Inprogress or Delivered or Failed</faxStatus>
          </recp_track>
          <recp_track>
            <recipient xsi:nil="true" />
            <ResultDate>dateTime</ResultDate>
            <remarks>string</remarks>
            <Status>Inprogress or Delivered or SB or HB or UNF or TU or MF or BD or Failed</Status>
            <OpenDate>dateTime</OpenDate>
            <MMId>long</MMId>
            <faxStatus>Inprogress or Delivered or Failed</faxStatus>
          </recp_track>
        </RecipientDetails>
      </getDetailedTrackingUTCResult>
    </getDetailedTrackingUTCResponse>
  </soap12:Body>
</soap12:Envelope>