MagnetMail Web Service


Click here for a complete list of operations.

getGroupsEx

Takes up to 6 arguments - user_id, display_status(optional), subscription_groups(optional), group_id(optional), group_name(optional), and daysRecent(optional). Returns an array of 'group' type.

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

<?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>
    <getGroupsEx xmlns="http://www.magnetmail.net/">
      <user_id>string</user_id>
      <display_status>int</display_status>
      <subscription_groups>int</subscription_groups>
      <group_id>int</group_id>
      <group_name>string</group_name>
      <days_recent>int</days_recent>
    </getGroupsEx>
  </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>
    <getGroupsExResponse xmlns="http://www.magnetmail.net/">
      <getGroupsExResult>
        <group>
          <group_id>int</group_id>
          <group_name>string</group_name>
          <group_created>dateTime</group_created>
          <display_status>boolean</display_status>
          <subscription_group>boolean</subscription_group>
          <last_updated_date>dateTime</last_updated_date>
          <last_updated_loginid>int</last_updated_loginid>
        </group>
        <group>
          <group_id>int</group_id>
          <group_name>string</group_name>
          <group_created>dateTime</group_created>
          <display_status>boolean</display_status>
          <subscription_group>boolean</subscription_group>
          <last_updated_date>dateTime</last_updated_date>
          <last_updated_loginid>int</last_updated_loginid>
        </group>
      </getGroupsExResult>
    </getGroupsExResponse>
  </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>
    <getGroupsEx xmlns="http://www.magnetmail.net/">
      <user_id>string</user_id>
      <display_status>int</display_status>
      <subscription_groups>int</subscription_groups>
      <group_id>int</group_id>
      <group_name>string</group_name>
      <days_recent>int</days_recent>
    </getGroupsEx>
  </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>
    <getGroupsExResponse xmlns="http://www.magnetmail.net/">
      <getGroupsExResult>
        <group>
          <group_id>int</group_id>
          <group_name>string</group_name>
          <group_created>dateTime</group_created>
          <display_status>boolean</display_status>
          <subscription_group>boolean</subscription_group>
          <last_updated_date>dateTime</last_updated_date>
          <last_updated_loginid>int</last_updated_loginid>
        </group>
        <group>
          <group_id>int</group_id>
          <group_name>string</group_name>
          <group_created>dateTime</group_created>
          <display_status>boolean</display_status>
          <subscription_group>boolean</subscription_group>
          <last_updated_date>dateTime</last_updated_date>
          <last_updated_loginid>int</last_updated_loginid>
        </group>
      </getGroupsExResult>
    </getGroupsExResponse>
  </soap12:Body>
</soap12:Envelope>