MagnetMail Web Service Web Service

MagnetMail Web Service

Click here for a complete list of operations.

getRecipientHistory

BETA: Get recipient history based on the recipient_id.

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

<?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>
    <getRecipientHistory xmlns="http://www.magnetmail.net/">
      <user_id>string</user_id>
      <recipient_id>long</recipient_id>
    </getRecipientHistory>
  </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>
    <getRecipientHistoryResponse xmlns="http://www.magnetmail.net/">
      <getRecipientHistoryResult>
        <emailHistory>
          <email_history>
            <message_name>string</message_name>
            <message_id>int</message_id>
            <sent_date>dateTime</sent_date>
            <open_date>dateTime</open_date>
            <send_result>string</send_result>
            <links xsi:nil="true" />
          </email_history>
          <email_history>
            <message_name>string</message_name>
            <message_id>int</message_id>
            <sent_date>dateTime</sent_date>
            <open_date>dateTime</open_date>
            <send_result>string</send_result>
            <links xsi:nil="true" />
          </email_history>
        </emailHistory>
        <faxHistory>
          <fax_history>
            <message_name>string</message_name>
            <sent_date>dateTime</sent_date>
            <fax_status>string</fax_status>
            <connect_time>int</connect_time>
          </fax_history>
          <fax_history>
            <message_name>string</message_name>
            <sent_date>dateTime</sent_date>
            <fax_status>string</fax_status>
            <connect_time>int</connect_time>
          </fax_history>
        </faxHistory>
        <formHistory>
          <form_history>
            <form_name>string</form_name>
            <submit_date>dateTime</submit_date>
          </form_history>
          <form_history>
            <form_name>string</form_name>
            <submit_date>dateTime</submit_date>
          </form_history>
        </formHistory>
      </getRecipientHistoryResult>
    </getRecipientHistoryResponse>
  </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>
    <getRecipientHistory xmlns="http://www.magnetmail.net/">
      <user_id>string</user_id>
      <recipient_id>long</recipient_id>
    </getRecipientHistory>
  </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>
    <getRecipientHistoryResponse xmlns="http://www.magnetmail.net/">
      <getRecipientHistoryResult>
        <emailHistory>
          <email_history>
            <message_name>string</message_name>
            <message_id>int</message_id>
            <sent_date>dateTime</sent_date>
            <open_date>dateTime</open_date>
            <send_result>string</send_result>
            <links xsi:nil="true" />
          </email_history>
          <email_history>
            <message_name>string</message_name>
            <message_id>int</message_id>
            <sent_date>dateTime</sent_date>
            <open_date>dateTime</open_date>
            <send_result>string</send_result>
            <links xsi:nil="true" />
          </email_history>
        </emailHistory>
        <faxHistory>
          <fax_history>
            <message_name>string</message_name>
            <sent_date>dateTime</sent_date>
            <fax_status>string</fax_status>
            <connect_time>int</connect_time>
          </fax_history>
          <fax_history>
            <message_name>string</message_name>
            <sent_date>dateTime</sent_date>
            <fax_status>string</fax_status>
            <connect_time>int</connect_time>
          </fax_history>
        </faxHistory>
        <formHistory>
          <form_history>
            <form_name>string</form_name>
            <submit_date>dateTime</submit_date>
          </form_history>
          <form_history>
            <form_name>string</form_name>
            <submit_date>dateTime</submit_date>
          </form_history>
        </formHistory>
      </getRecipientHistoryResult>
    </getRecipientHistoryResponse>
  </soap12:Body>
</soap12:Envelope>