WebMethods Web Service

WebMethods

Click here for a complete list of operations.

GetConstituentConsentsAndConfigurations

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 /webservices/webmethods.asmx HTTP/1.1
Host: support.commonwealthclub.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://blackbaud.com/webservices/GetConstituentConsentsAndConfigurations"

<?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>
    <GetConstituentConsentsAndConfigurations xmlns="http://blackbaud.com/webservices">
      <consentPartID>int</consentPartID>
    </GetConstituentConsentsAndConfigurations>
  </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>
    <GetConstituentConsentsAndConfigurationsResponse xmlns="http://blackbaud.com/webservices">
      <GetConstituentConsentsAndConfigurationsResult>
        <RequestNoEmail>boolean</RequestNoEmail>
        <ConstituentContactConsents>
          <ContactConsent>
            <ConsentID xmlns="urn:blackbaud.RE7.XDATA">int</ConsentID>
            <Sequence xmlns="urn:blackbaud.RE7.XDATA">int</Sequence>
            <ConstituentId xmlns="urn:blackbaud.RE7.XDATA">int</ConstituentId>
            <Channel xmlns="urn:blackbaud.RE7.XDATA">int</Channel>
            <Category xmlns="urn:blackbaud.RE7.XDATA">int</Category>
            <Response xmlns="urn:blackbaud.RE7.XDATA">int</Response>
            <ConsentDate xmlns="urn:blackbaud.RE7.XDATA">dateTime</ConsentDate>
            <DateAdded xmlns="urn:blackbaud.RE7.XDATA">dateTime</DateAdded>
            <Source xmlns="urn:blackbaud.RE7.XDATA">string</Source>
            <Username xmlns="urn:blackbaud.RE7.XDATA">string</Username>
            <ConsentStatement xmlns="urn:blackbaud.RE7.XDATA">string</ConsentStatement>
            <PrivacyPolicy xmlns="urn:blackbaud.RE7.XDATA">string</PrivacyPolicy>
            <FormLocation xmlns="urn:blackbaud.RE7.XDATA">string</FormLocation>
            <FormVersion xmlns="urn:blackbaud.RE7.XDATA">string</FormVersion>
            <ImportID xmlns="urn:blackbaud.RE7.XDATA">string</ImportID>
            <ChannelName xmlns="urn:blackbaud.RE7.XDATA">string</ChannelName>
            <CategoryName xmlns="urn:blackbaud.RE7.XDATA">string</CategoryName>
            <AlreadyProcessed xmlns="urn:blackbaud.RE7.XDATA">boolean</AlreadyProcessed>
          </ContactConsent>
          <ContactConsent>
            <ConsentID xmlns="urn:blackbaud.RE7.XDATA">int</ConsentID>
            <Sequence xmlns="urn:blackbaud.RE7.XDATA">int</Sequence>
            <ConstituentId xmlns="urn:blackbaud.RE7.XDATA">int</ConstituentId>
            <Channel xmlns="urn:blackbaud.RE7.XDATA">int</Channel>
            <Category xmlns="urn:blackbaud.RE7.XDATA">int</Category>
            <Response xmlns="urn:blackbaud.RE7.XDATA">int</Response>
            <ConsentDate xmlns="urn:blackbaud.RE7.XDATA">dateTime</ConsentDate>
            <DateAdded xmlns="urn:blackbaud.RE7.XDATA">dateTime</DateAdded>
            <Source xmlns="urn:blackbaud.RE7.XDATA">string</Source>
            <Username xmlns="urn:blackbaud.RE7.XDATA">string</Username>
            <ConsentStatement xmlns="urn:blackbaud.RE7.XDATA">string</ConsentStatement>
            <PrivacyPolicy xmlns="urn:blackbaud.RE7.XDATA">string</PrivacyPolicy>
            <FormLocation xmlns="urn:blackbaud.RE7.XDATA">string</FormLocation>
            <FormVersion xmlns="urn:blackbaud.RE7.XDATA">string</FormVersion>
            <ImportID xmlns="urn:blackbaud.RE7.XDATA">string</ImportID>
            <ChannelName xmlns="urn:blackbaud.RE7.XDATA">string</ChannelName>
            <CategoryName xmlns="urn:blackbaud.RE7.XDATA">string</CategoryName>
            <AlreadyProcessed xmlns="urn:blackbaud.RE7.XDATA">boolean</AlreadyProcessed>
          </ContactConsent>
        </ConstituentContactConsents>
        <ConsentOptionConfigurationsInRE>
          <ConsentOptionData>
            <SystemId xmlns="Blackbaud.WebService.CoreTech.RE7Service">string</SystemId>
            <Channel xmlns="Blackbaud.WebService.CoreTech.RE7Service">ConsentChannel_None or ConsentChannel_Email or ConsentChannel_Mail or ConsentChannel_SMS or ConsentChannel_Phone or ConsentChannel_Auto_Phone or ConsentChannel_Social or ConsentChannel_DataProcessing or ConsentChannel_Other</Channel>
            <ChannelName xmlns="Blackbaud.WebService.CoreTech.RE7Service">string</ChannelName>
            <Category xmlns="Blackbaud.WebService.CoreTech.RE7Service">int</Category>
            <CategoryName xmlns="Blackbaud.WebService.CoreTech.RE7Service">string</CategoryName>
          </ConsentOptionData>
          <ConsentOptionData>
            <SystemId xmlns="Blackbaud.WebService.CoreTech.RE7Service">string</SystemId>
            <Channel xmlns="Blackbaud.WebService.CoreTech.RE7Service">ConsentChannel_None or ConsentChannel_Email or ConsentChannel_Mail or ConsentChannel_SMS or ConsentChannel_Phone or ConsentChannel_Auto_Phone or ConsentChannel_Social or ConsentChannel_DataProcessing or ConsentChannel_Other</Channel>
            <ChannelName xmlns="Blackbaud.WebService.CoreTech.RE7Service">string</ChannelName>
            <Category xmlns="Blackbaud.WebService.CoreTech.RE7Service">int</Category>
            <CategoryName xmlns="Blackbaud.WebService.CoreTech.RE7Service">string</CategoryName>
          </ConsentOptionData>
        </ConsentOptionConfigurationsInRE>
      </GetConstituentConsentsAndConfigurationsResult>
    </GetConstituentConsentsAndConfigurationsResponse>
  </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 /webservices/webmethods.asmx HTTP/1.1
Host: support.commonwealthclub.org
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>
    <GetConstituentConsentsAndConfigurations xmlns="http://blackbaud.com/webservices">
      <consentPartID>int</consentPartID>
    </GetConstituentConsentsAndConfigurations>
  </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>
    <GetConstituentConsentsAndConfigurationsResponse xmlns="http://blackbaud.com/webservices">
      <GetConstituentConsentsAndConfigurationsResult>
        <RequestNoEmail>boolean</RequestNoEmail>
        <ConstituentContactConsents>
          <ContactConsent>
            <ConsentID xmlns="urn:blackbaud.RE7.XDATA">int</ConsentID>
            <Sequence xmlns="urn:blackbaud.RE7.XDATA">int</Sequence>
            <ConstituentId xmlns="urn:blackbaud.RE7.XDATA">int</ConstituentId>
            <Channel xmlns="urn:blackbaud.RE7.XDATA">int</Channel>
            <Category xmlns="urn:blackbaud.RE7.XDATA">int</Category>
            <Response xmlns="urn:blackbaud.RE7.XDATA">int</Response>
            <ConsentDate xmlns="urn:blackbaud.RE7.XDATA">dateTime</ConsentDate>
            <DateAdded xmlns="urn:blackbaud.RE7.XDATA">dateTime</DateAdded>
            <Source xmlns="urn:blackbaud.RE7.XDATA">string</Source>
            <Username xmlns="urn:blackbaud.RE7.XDATA">string</Username>
            <ConsentStatement xmlns="urn:blackbaud.RE7.XDATA">string</ConsentStatement>
            <PrivacyPolicy xmlns="urn:blackbaud.RE7.XDATA">string</PrivacyPolicy>
            <FormLocation xmlns="urn:blackbaud.RE7.XDATA">string</FormLocation>
            <FormVersion xmlns="urn:blackbaud.RE7.XDATA">string</FormVersion>
            <ImportID xmlns="urn:blackbaud.RE7.XDATA">string</ImportID>
            <ChannelName xmlns="urn:blackbaud.RE7.XDATA">string</ChannelName>
            <CategoryName xmlns="urn:blackbaud.RE7.XDATA">string</CategoryName>
            <AlreadyProcessed xmlns="urn:blackbaud.RE7.XDATA">boolean</AlreadyProcessed>
          </ContactConsent>
          <ContactConsent>
            <ConsentID xmlns="urn:blackbaud.RE7.XDATA">int</ConsentID>
            <Sequence xmlns="urn:blackbaud.RE7.XDATA">int</Sequence>
            <ConstituentId xmlns="urn:blackbaud.RE7.XDATA">int</ConstituentId>
            <Channel xmlns="urn:blackbaud.RE7.XDATA">int</Channel>
            <Category xmlns="urn:blackbaud.RE7.XDATA">int</Category>
            <Response xmlns="urn:blackbaud.RE7.XDATA">int</Response>
            <ConsentDate xmlns="urn:blackbaud.RE7.XDATA">dateTime</ConsentDate>
            <DateAdded xmlns="urn:blackbaud.RE7.XDATA">dateTime</DateAdded>
            <Source xmlns="urn:blackbaud.RE7.XDATA">string</Source>
            <Username xmlns="urn:blackbaud.RE7.XDATA">string</Username>
            <ConsentStatement xmlns="urn:blackbaud.RE7.XDATA">string</ConsentStatement>
            <PrivacyPolicy xmlns="urn:blackbaud.RE7.XDATA">string</PrivacyPolicy>
            <FormLocation xmlns="urn:blackbaud.RE7.XDATA">string</FormLocation>
            <FormVersion xmlns="urn:blackbaud.RE7.XDATA">string</FormVersion>
            <ImportID xmlns="urn:blackbaud.RE7.XDATA">string</ImportID>
            <ChannelName xmlns="urn:blackbaud.RE7.XDATA">string</ChannelName>
            <CategoryName xmlns="urn:blackbaud.RE7.XDATA">string</CategoryName>
            <AlreadyProcessed xmlns="urn:blackbaud.RE7.XDATA">boolean</AlreadyProcessed>
          </ContactConsent>
        </ConstituentContactConsents>
        <ConsentOptionConfigurationsInRE>
          <ConsentOptionData>
            <SystemId xmlns="Blackbaud.WebService.CoreTech.RE7Service">string</SystemId>
            <Channel xmlns="Blackbaud.WebService.CoreTech.RE7Service">ConsentChannel_None or ConsentChannel_Email or ConsentChannel_Mail or ConsentChannel_SMS or ConsentChannel_Phone or ConsentChannel_Auto_Phone or ConsentChannel_Social or ConsentChannel_DataProcessing or ConsentChannel_Other</Channel>
            <ChannelName xmlns="Blackbaud.WebService.CoreTech.RE7Service">string</ChannelName>
            <Category xmlns="Blackbaud.WebService.CoreTech.RE7Service">int</Category>
            <CategoryName xmlns="Blackbaud.WebService.CoreTech.RE7Service">string</CategoryName>
          </ConsentOptionData>
          <ConsentOptionData>
            <SystemId xmlns="Blackbaud.WebService.CoreTech.RE7Service">string</SystemId>
            <Channel xmlns="Blackbaud.WebService.CoreTech.RE7Service">ConsentChannel_None or ConsentChannel_Email or ConsentChannel_Mail or ConsentChannel_SMS or ConsentChannel_Phone or ConsentChannel_Auto_Phone or ConsentChannel_Social or ConsentChannel_DataProcessing or ConsentChannel_Other</Channel>
            <ChannelName xmlns="Blackbaud.WebService.CoreTech.RE7Service">string</ChannelName>
            <Category xmlns="Blackbaud.WebService.CoreTech.RE7Service">int</Category>
            <CategoryName xmlns="Blackbaud.WebService.CoreTech.RE7Service">string</CategoryName>
          </ConsentOptionData>
        </ConsentOptionConfigurationsInRE>
      </GetConstituentConsentsAndConfigurationsResult>
    </GetConstituentConsentsAndConfigurationsResponse>
  </soap12:Body>
</soap12:Envelope>