Retrieving Status of Mailing Lists Service

Use the get-status operation to retrieve status of mailing list service on a specified site.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet retrieving status of a mailing lists service includes the get-status operation node:

<packet version="1.4.2.0">
<maillist>
<get-status>
...  
</get-status>
</maillist>
</packet>

 

The get-status node is presented by the MaillistGetStatusInputType type (maillist.xsd), and its graphical representation is as follows:

RetStatusRPS

Remarks

You can retrieve status of mailing lists service on multiple sites using different filtering rules in a single packet. Add as many get-status operations as the number of different filtering rules to be applied.

<get-status>
   ...
</get-status>
   ...
<get-status>
   ...
</get-status>

 

 

Response Packet Structure

The get-status node of the output XML packet is presented by type MaillistGetStatusOutputType (maillist.xsd) and structured as follows:

RetStatuRePS

 

 

Samples

Retrieving status of mailing lists service on a single site

This request packet retrieves status of the mailing lists service on the site called Mysite.com.

<packet>
<maillist>
<get-status>
   <filter>
      <site-name>Mysite.com</site-name>
   </filter>
</get-status>
</maillist>
</packet>

Response:

<packet>
<maillist>
<get-status>
   <result>
      <status>ok</status>
      <filter-id>Mysite.com</filter-id>
      <service-status>true</service-status>
   </result>
</get-status>
</maillist>
</packet>

 

If the site was not found on the server, the result looks as follows:

<packet>
<maillist>
<get-status>
   <result>
      <status>error</status>
      <errcode>1015</errcode>
      <errtext>Domain does not exist</errtext>
      <filter-id>Mysite.com</filter-id>
   </result>
</get-status>
</maillist>
</packet> 
Retrieving status of mailing lists service on multiple sites

This request packet retrieves status of mailing list service on the sites Mysite.com, My2site.com, and on the site specified by ID 5.

<packet>
<maillist>
<get-status>
   <filter>
      <site-name>Mysite.com</site-name>
      <site-name>My2site.com</site-name>
   </filter>
</get-status>
<get-status>
   <filter>
      <site-id>5</site-id>
   </filter>
</get-status>
</maillist>
</packet>

Response:

<packet>
<maillist>
<get-status>
   <result>
      <status>ok</status>
      <filter-id>Mysite.com</filter-id>
      <service-status>false</service-status>
   </result>
   <result>
      <status>ok</status>
      <filter-id>My2site.com</filter-id>
      <service-status>true</service-status>
   </result>
</get-status>
<get-status>
   <result>
      <status>ok</status>
      <filter-id>5</filter-id>
      <service-status>true</service-status>
   </result>
</get-status>
</maillist>
</packet>