Api

Click here for a complete list of operations.

GetOptInListContacts

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 /v/2/Api.asmx HTTP/1.1
Host: api.charityengine.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.bisglobal.net/GetOptInListContacts"

<?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>
    <GetOptInListContacts xmlns="https://api.bisglobal.net/">
      <credentials>
        <Username>string</Username>
        <Password>string</Password>
        <AuthenticationToken>string</AuthenticationToken>
        <AuthenticationType>WebServiceUser or CharityEngineAdminUser or Contact</AuthenticationType>
      </credentials>
      <queryParameters>
        <OptInList_Id>long</OptInList_Id>
        <SubscribedDate_From>dateTime</SubscribedDate_From>
        <SubscribedDate_To>dateTime</SubscribedDate_To>
        <UnsubscribedDate_From>dateTime</UnsubscribedDate_From>
        <UnsubscribedDate_To>dateTime</UnsubscribedDate_To>
        <DtStamp_From>dateTime</DtStamp_From>
        <DtStamp_To>dateTime</DtStamp_To>
      </queryParameters>
    </GetOptInListContacts>
  </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>
    <GetOptInListContactsResponse xmlns="https://api.bisglobal.net/">
      <GetOptInListContactsResult>
        <ListContacts>
          <ListContact>
            <Contact_Id>long</Contact_Id>
            <OptInList_Id>long</OptInList_Id>
            <Subscribed>boolean</Subscribed>
            <DateSubscribed>dateTime</DateSubscribed>
            <DateUnsubscribed>dateTime</DateUnsubscribed>
          </ListContact>
          <ListContact>
            <Contact_Id>long</Contact_Id>
            <OptInList_Id>long</OptInList_Id>
            <Subscribed>boolean</Subscribed>
            <DateSubscribed>dateTime</DateSubscribed>
            <DateUnsubscribed>dateTime</DateUnsubscribed>
          </ListContact>
        </ListContacts>
      </GetOptInListContactsResult>
    </GetOptInListContactsResponse>
  </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 /v/2/Api.asmx HTTP/1.1
Host: api.charityengine.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:Body>
    <GetOptInListContacts xmlns="https://api.bisglobal.net/">
      <credentials>
        <Username>string</Username>
        <Password>string</Password>
        <AuthenticationToken>string</AuthenticationToken>
        <AuthenticationType>WebServiceUser or CharityEngineAdminUser or Contact</AuthenticationType>
      </credentials>
      <queryParameters>
        <OptInList_Id>long</OptInList_Id>
        <SubscribedDate_From>dateTime</SubscribedDate_From>
        <SubscribedDate_To>dateTime</SubscribedDate_To>
        <UnsubscribedDate_From>dateTime</UnsubscribedDate_From>
        <UnsubscribedDate_To>dateTime</UnsubscribedDate_To>
        <DtStamp_From>dateTime</DtStamp_From>
        <DtStamp_To>dateTime</DtStamp_To>
      </queryParameters>
    </GetOptInListContacts>
  </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>
    <GetOptInListContactsResponse xmlns="https://api.bisglobal.net/">
      <GetOptInListContactsResult>
        <ListContacts>
          <ListContact>
            <Contact_Id>long</Contact_Id>
            <OptInList_Id>long</OptInList_Id>
            <Subscribed>boolean</Subscribed>
            <DateSubscribed>dateTime</DateSubscribed>
            <DateUnsubscribed>dateTime</DateUnsubscribed>
          </ListContact>
          <ListContact>
            <Contact_Id>long</Contact_Id>
            <OptInList_Id>long</OptInList_Id>
            <Subscribed>boolean</Subscribed>
            <DateSubscribed>dateTime</DateSubscribed>
            <DateUnsubscribed>dateTime</DateUnsubscribed>
          </ListContact>
        </ListContacts>
      </GetOptInListContactsResult>
    </GetOptInListContactsResponse>
  </soap12:Body>
</soap12:Envelope>