Messenger


Click here for a complete list of operations.

HTTP_FindDistributionLists

Finds distibution lists with search criteria specified.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
ParameterValue
customerID:
userName:
userPassword:
listId:
listName:
listCategory:

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 /bms/Soap/Messenger.asmx HTTP/1.1
Host: messaging.ooredoo.qa
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://pmmsoapmessenger.com/HTTP_FindDistributionLists"

<?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>
    <HTTP_FindDistributionLists xmlns="http://pmmsoapmessenger.com/">
      <customerID>int</customerID>
      <userName>string</userName>
      <userPassword>string</userPassword>
      <listId>string</listId>
      <listName>string</listName>
      <listCategory>string</listCategory>
    </HTTP_FindDistributionLists>
  </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>
    <HTTP_FindDistributionListsResponse xmlns="http://pmmsoapmessenger.com/">
      <HTTP_FindDistributionListsResult>
        <Lists>
          <DistributionListDescription>
            <ID>guid</ID>
            <Name>string</Name>
            <Category>string</Category>
            <RecipientsCount>int</RecipientsCount>
            <Version>int</Version>
            <Private>boolean</Private>
            <Type>DistributionList or SmartList</Type>
          </DistributionListDescription>
          <DistributionListDescription>
            <ID>guid</ID>
            <Name>string</Name>
            <Category>string</Category>
            <RecipientsCount>int</RecipientsCount>
            <Version>int</Version>
            <Private>boolean</Private>
            <Type>DistributionList or SmartList</Type>
          </DistributionListDescription>
        </Lists>
      </HTTP_FindDistributionListsResult>
    </HTTP_FindDistributionListsResponse>
  </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 /bms/Soap/Messenger.asmx HTTP/1.1
Host: messaging.ooredoo.qa
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>
    <HTTP_FindDistributionLists xmlns="http://pmmsoapmessenger.com/">
      <customerID>int</customerID>
      <userName>string</userName>
      <userPassword>string</userPassword>
      <listId>string</listId>
      <listName>string</listName>
      <listCategory>string</listCategory>
    </HTTP_FindDistributionLists>
  </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>
    <HTTP_FindDistributionListsResponse xmlns="http://pmmsoapmessenger.com/">
      <HTTP_FindDistributionListsResult>
        <Lists>
          <DistributionListDescription>
            <ID>guid</ID>
            <Name>string</Name>
            <Category>string</Category>
            <RecipientsCount>int</RecipientsCount>
            <Version>int</Version>
            <Private>boolean</Private>
            <Type>DistributionList or SmartList</Type>
          </DistributionListDescription>
          <DistributionListDescription>
            <ID>guid</ID>
            <Name>string</Name>
            <Category>string</Category>
            <RecipientsCount>int</RecipientsCount>
            <Version>int</Version>
            <Private>boolean</Private>
            <Type>DistributionList or SmartList</Type>
          </DistributionListDescription>
        </Lists>
      </HTTP_FindDistributionListsResult>
    </HTTP_FindDistributionListsResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /bms/Soap/Messenger.asmx/HTTP_FindDistributionLists?customerID=string&userName=string&userPassword=string&listId=string&listName=string&listCategory=string HTTP/1.1
Host: messaging.ooredoo.qa
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<FindListsResult xmlns="http://pmmsoapmessenger.com/">
  <Lists>
    <DistributionListDescription>
      <ID>guid</ID>
      <Name>string</Name>
      <Category>string</Category>
      <RecipientsCount>int</RecipientsCount>
      <Version>int</Version>
      <Private>boolean</Private>
      <Type>DistributionList or SmartList</Type>
    </DistributionListDescription>
    <DistributionListDescription>
      <ID>guid</ID>
      <Name>string</Name>
      <Category>string</Category>
      <RecipientsCount>int</RecipientsCount>
      <Version>int</Version>
      <Private>boolean</Private>
      <Type>DistributionList or SmartList</Type>
    </DistributionListDescription>
  </Lists>
</FindListsResult>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /bms/Soap/Messenger.asmx/HTTP_FindDistributionLists HTTP/1.1
Host: messaging.ooredoo.qa
Content-Type: application/x-www-form-urlencoded
Content-Length: length

customerID=string&userName=string&userPassword=string&listId=string&listName=string&listCategory=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<FindListsResult xmlns="http://pmmsoapmessenger.com/">
  <Lists>
    <DistributionListDescription>
      <ID>guid</ID>
      <Name>string</Name>
      <Category>string</Category>
      <RecipientsCount>int</RecipientsCount>
      <Version>int</Version>
      <Private>boolean</Private>
      <Type>DistributionList or SmartList</Type>
    </DistributionListDescription>
    <DistributionListDescription>
      <ID>guid</ID>
      <Name>string</Name>
      <Category>string</Category>
      <RecipientsCount>int</RecipientsCount>
      <Version>int</Version>
      <Private>boolean</Private>
      <Type>DistributionList or SmartList</Type>
    </DistributionListDescription>
  </Lists>
</FindListsResult>