Veetro Web Service Methods


Click here for a complete list of operations.

GetSubscriptionsByMailingList

[Permission: Employee]
Returns a list of Subscriptions for the specified mailing list.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
mailingListID:

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 /xml HTTP/1.1
Host: admin.worketc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://schema.veetro.com/GetSubscriptionsByMailingList"

<?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>
    <GetSubscriptionsByMailingList xmlns="http://schema.veetro.com">
      <mailingListID>int</mailingListID>
    </GetSubscriptionsByMailingList>
  </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>
    <GetSubscriptionsByMailingListResponse xmlns="http://schema.veetro.com">
      <GetSubscriptionsByMailingListResult>
        <Subscription>
          <SubscriptionID>int</SubscriptionID>
          <EntityID>int</EntityID>
          <MailingListID>int</MailingListID>
          <UnsubscribeDate>dateTime</UnsubscribeDate>
          <MailingListName>string</MailingListName>
        </Subscription>
        <Subscription>
          <SubscriptionID>int</SubscriptionID>
          <EntityID>int</EntityID>
          <MailingListID>int</MailingListID>
          <UnsubscribeDate>dateTime</UnsubscribeDate>
          <MailingListName>string</MailingListName>
        </Subscription>
      </GetSubscriptionsByMailingListResult>
    </GetSubscriptionsByMailingListResponse>
  </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 /xml HTTP/1.1
Host: admin.worketc.com
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>
    <GetSubscriptionsByMailingList xmlns="http://schema.veetro.com">
      <mailingListID>int</mailingListID>
    </GetSubscriptionsByMailingList>
  </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>
    <GetSubscriptionsByMailingListResponse xmlns="http://schema.veetro.com">
      <GetSubscriptionsByMailingListResult>
        <Subscription>
          <SubscriptionID>int</SubscriptionID>
          <EntityID>int</EntityID>
          <MailingListID>int</MailingListID>
          <UnsubscribeDate>dateTime</UnsubscribeDate>
          <MailingListName>string</MailingListName>
        </Subscription>
        <Subscription>
          <SubscriptionID>int</SubscriptionID>
          <EntityID>int</EntityID>
          <MailingListID>int</MailingListID>
          <UnsubscribeDate>dateTime</UnsubscribeDate>
          <MailingListName>string</MailingListName>
        </Subscription>
      </GetSubscriptionsByMailingListResult>
    </GetSubscriptionsByMailingListResponse>
  </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 /xml/GetSubscriptionsByMailingList?mailingListID=string HTTP/1.1
Host: admin.worketc.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfSubscription xmlns="http://schema.veetro.com">
  <Subscription>
    <SubscriptionID>int</SubscriptionID>
    <EntityID>int</EntityID>
    <MailingListID>int</MailingListID>
    <UnsubscribeDate>dateTime</UnsubscribeDate>
    <MailingListName>string</MailingListName>
  </Subscription>
  <Subscription>
    <SubscriptionID>int</SubscriptionID>
    <EntityID>int</EntityID>
    <MailingListID>int</MailingListID>
    <UnsubscribeDate>dateTime</UnsubscribeDate>
    <MailingListName>string</MailingListName>
  </Subscription>
</ArrayOfSubscription>

HTTP POST

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

POST /xml/GetSubscriptionsByMailingList HTTP/1.1
Host: admin.worketc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

mailingListID=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfSubscription xmlns="http://schema.veetro.com">
  <Subscription>
    <SubscriptionID>int</SubscriptionID>
    <EntityID>int</EntityID>
    <MailingListID>int</MailingListID>
    <UnsubscribeDate>dateTime</UnsubscribeDate>
    <MailingListName>string</MailingListName>
  </Subscription>
  <Subscription>
    <SubscriptionID>int</SubscriptionID>
    <EntityID>int</EntityID>
    <MailingListID>int</MailingListID>
    <UnsubscribeDate>dateTime</UnsubscribeDate>
    <MailingListName>string</MailingListName>
  </Subscription>
</ArrayOfSubscription>