Members Web Service

Members

Click here for a complete list of operations.

GetPreferences

View all the options for campaigns and communication channels.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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 /Plus2MemberWebserviceDEV/Members.asmx HTTP/1.1
Host: tst.myeveryoneactive.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.gladstonemrm.com/memberwebservice/GetPreferences"

<?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:Header>
    <AuthHeader xmlns="http://www.gladstonemrm.com/memberwebservice/">
      <Username>string</Username>
      <Password>string</Password>
      <AppName>string</AppName>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <GetPreferences xmlns="http://www.gladstonemrm.com/memberwebservice/" />
  </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>
    <GetPreferencesResponse xmlns="http://www.gladstonemrm.com/memberwebservice/">
      <GetPreferencesResult>
        <ConsentNote>string</ConsentNote>
        <AllCommunicationCampaigns>
          <CommunicationCampaign>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <ExpiryDate>dateTime</ExpiryDate>
            <CategoryId>string</CategoryId>
            <CategoryName>string</CategoryName>
          </CommunicationCampaign>
          <CommunicationCampaign>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <ExpiryDate>dateTime</ExpiryDate>
            <CategoryId>string</CategoryId>
            <CategoryName>string</CategoryName>
          </CommunicationCampaign>
        </AllCommunicationCampaigns>
        <AllCommunicationChannels>
          <CommunicationChannel>
            <Id>string</Id>
            <Name>string</Name>
          </CommunicationChannel>
          <CommunicationChannel>
            <Id>string</Id>
            <Name>string</Name>
          </CommunicationChannel>
        </AllCommunicationChannels>
        <SuccessFailureWithMessage>
          <SuccessFailure>Success or Failure or DoneWithErrors</SuccessFailure>
          <ErrorMessage>string</ErrorMessage>
          <ErrorCode>int</ErrorCode>
        </SuccessFailureWithMessage>
      </GetPreferencesResult>
    </GetPreferencesResponse>
  </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 /Plus2MemberWebserviceDEV/Members.asmx HTTP/1.1
Host: tst.myeveryoneactive.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:Header>
    <AuthHeader xmlns="http://www.gladstonemrm.com/memberwebservice/">
      <Username>string</Username>
      <Password>string</Password>
      <AppName>string</AppName>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <GetPreferences xmlns="http://www.gladstonemrm.com/memberwebservice/" />
  </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>
    <GetPreferencesResponse xmlns="http://www.gladstonemrm.com/memberwebservice/">
      <GetPreferencesResult>
        <ConsentNote>string</ConsentNote>
        <AllCommunicationCampaigns>
          <CommunicationCampaign>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <ExpiryDate>dateTime</ExpiryDate>
            <CategoryId>string</CategoryId>
            <CategoryName>string</CategoryName>
          </CommunicationCampaign>
          <CommunicationCampaign>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <ExpiryDate>dateTime</ExpiryDate>
            <CategoryId>string</CategoryId>
            <CategoryName>string</CategoryName>
          </CommunicationCampaign>
        </AllCommunicationCampaigns>
        <AllCommunicationChannels>
          <CommunicationChannel>
            <Id>string</Id>
            <Name>string</Name>
          </CommunicationChannel>
          <CommunicationChannel>
            <Id>string</Id>
            <Name>string</Name>
          </CommunicationChannel>
        </AllCommunicationChannels>
        <SuccessFailureWithMessage>
          <SuccessFailure>Success or Failure or DoneWithErrors</SuccessFailure>
          <ErrorMessage>string</ErrorMessage>
          <ErrorCode>int</ErrorCode>
        </SuccessFailureWithMessage>
      </GetPreferencesResult>
    </GetPreferencesResponse>
  </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 /Plus2MemberWebserviceDEV/Members.asmx/GetPreferences? HTTP/1.1
Host: tst.myeveryoneactive.com

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

<?xml version="1.0" encoding="utf-8"?>
<GetPreferencesResult xmlns="http://www.gladstonemrm.com/memberwebservice/">
  <ConsentNote>string</ConsentNote>
  <AllCommunicationCampaigns>
    <CommunicationCampaign>
      <Id>string</Id>
      <Name>string</Name>
      <Description>string</Description>
      <ExpiryDate>dateTime</ExpiryDate>
      <CategoryId>string</CategoryId>
      <CategoryName>string</CategoryName>
    </CommunicationCampaign>
    <CommunicationCampaign>
      <Id>string</Id>
      <Name>string</Name>
      <Description>string</Description>
      <ExpiryDate>dateTime</ExpiryDate>
      <CategoryId>string</CategoryId>
      <CategoryName>string</CategoryName>
    </CommunicationCampaign>
  </AllCommunicationCampaigns>
  <AllCommunicationChannels>
    <CommunicationChannel>
      <Id>string</Id>
      <Name>string</Name>
    </CommunicationChannel>
    <CommunicationChannel>
      <Id>string</Id>
      <Name>string</Name>
    </CommunicationChannel>
  </AllCommunicationChannels>
  <SuccessFailureWithMessage>
    <SuccessFailure>Success or Failure or DoneWithErrors</SuccessFailure>
    <ErrorMessage>string</ErrorMessage>
    <ErrorCode>int</ErrorCode>
  </SuccessFailureWithMessage>
</GetPreferencesResult>

HTTP POST

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

POST /Plus2MemberWebserviceDEV/Members.asmx/GetPreferences HTTP/1.1
Host: tst.myeveryoneactive.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<GetPreferencesResult xmlns="http://www.gladstonemrm.com/memberwebservice/">
  <ConsentNote>string</ConsentNote>
  <AllCommunicationCampaigns>
    <CommunicationCampaign>
      <Id>string</Id>
      <Name>string</Name>
      <Description>string</Description>
      <ExpiryDate>dateTime</ExpiryDate>
      <CategoryId>string</CategoryId>
      <CategoryName>string</CategoryName>
    </CommunicationCampaign>
    <CommunicationCampaign>
      <Id>string</Id>
      <Name>string</Name>
      <Description>string</Description>
      <ExpiryDate>dateTime</ExpiryDate>
      <CategoryId>string</CategoryId>
      <CategoryName>string</CategoryName>
    </CommunicationCampaign>
  </AllCommunicationCampaigns>
  <AllCommunicationChannels>
    <CommunicationChannel>
      <Id>string</Id>
      <Name>string</Name>
    </CommunicationChannel>
    <CommunicationChannel>
      <Id>string</Id>
      <Name>string</Name>
    </CommunicationChannel>
  </AllCommunicationChannels>
  <SuccessFailureWithMessage>
    <SuccessFailure>Success or Failure or DoneWithErrors</SuccessFailure>
    <ErrorMessage>string</ErrorMessage>
    <ErrorCode>int</ErrorCode>
  </SuccessFailureWithMessage>
</GetPreferencesResult>