MagnetMail Web Service
Click here for a complete list of operations.
getMessagesUTC
Returns a list of messages by different criterion. Messages can be filtered by sent date , create date, archive status, hide status, if it has fax, if it has email. Dates returned in UTC format
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/getMessagesUTC"
<?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>
<getMessagesUTC xmlns="http://www.magnetmail.net/">
<user_id>string</user_id>
<createStartDate>dateTime</createStartDate>
<createEndDate>dateTime</createEndDate>
<sentStartDate>dateTime</sentStartDate>
<sentEndDate>dateTime</sentEndDate>
<archived>no or yes or all</archived>
<hidden>no or yes or all</hidden>
<hasFax>no or yes or all</hasFax>
<hasEmail>no or yes or all</hasEmail>
</getMessagesUTC>
</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>
<getMessagesUTCResponse xmlns="http://www.magnetmail.net/">
<getMessagesUTCResult>
<MessageList>
<message>
<message_id>int</message_id>
<loginid>int</loginid>
<user_id>string</user_id>
<message_name>string</message_name>
<createDate>dateTime</createDate>
<lastSent>dateTime</lastSent>
</message>
<GroupsEmailSentTo>
<JobToGroup xsi:nil="true" />
<JobToGroup xsi:nil="true" />
</GroupsEmailSentTo>
<GroupsFaxSentTo>
<JobToGroup xsi:nil="true" />
<JobToGroup xsi:nil="true" />
</GroupsFaxSentTo>
</MessageList>
<MessageList>
<message>
<message_id>int</message_id>
<loginid>int</loginid>
<user_id>string</user_id>
<message_name>string</message_name>
<createDate>dateTime</createDate>
<lastSent>dateTime</lastSent>
</message>
<GroupsEmailSentTo>
<JobToGroup xsi:nil="true" />
<JobToGroup xsi:nil="true" />
</GroupsEmailSentTo>
<GroupsFaxSentTo>
<JobToGroup xsi:nil="true" />
<JobToGroup xsi:nil="true" />
</GroupsFaxSentTo>
</MessageList>
</getMessagesUTCResult>
</getMessagesUTCResponse>
</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>
<getMessagesUTC xmlns="http://www.magnetmail.net/">
<user_id>string</user_id>
<createStartDate>dateTime</createStartDate>
<createEndDate>dateTime</createEndDate>
<sentStartDate>dateTime</sentStartDate>
<sentEndDate>dateTime</sentEndDate>
<archived>no or yes or all</archived>
<hidden>no or yes or all</hidden>
<hasFax>no or yes or all</hasFax>
<hasEmail>no or yes or all</hasEmail>
</getMessagesUTC>
</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>
<getMessagesUTCResponse xmlns="http://www.magnetmail.net/">
<getMessagesUTCResult>
<MessageList>
<message>
<message_id>int</message_id>
<loginid>int</loginid>
<user_id>string</user_id>
<message_name>string</message_name>
<createDate>dateTime</createDate>
<lastSent>dateTime</lastSent>
</message>
<GroupsEmailSentTo>
<JobToGroup xsi:nil="true" />
<JobToGroup xsi:nil="true" />
</GroupsEmailSentTo>
<GroupsFaxSentTo>
<JobToGroup xsi:nil="true" />
<JobToGroup xsi:nil="true" />
</GroupsFaxSentTo>
</MessageList>
<MessageList>
<message>
<message_id>int</message_id>
<loginid>int</loginid>
<user_id>string</user_id>
<message_name>string</message_name>
<createDate>dateTime</createDate>
<lastSent>dateTime</lastSent>
</message>
<GroupsEmailSentTo>
<JobToGroup xsi:nil="true" />
<JobToGroup xsi:nil="true" />
</GroupsEmailSentTo>
<GroupsFaxSentTo>
<JobToGroup xsi:nil="true" />
<JobToGroup xsi:nil="true" />
</GroupsFaxSentTo>
</MessageList>
</getMessagesUTCResult>
</getMessagesUTCResponse>
</soap12:Body>
</soap12:Envelope>