GET api/communication/email/FamilyRecipients?filterSetID={filterSetID}&audience={audience}

Request Information

URI Parameters

Name	Description	Type	Additional information
filterSetID		integer	Required
audience		string	None.

Body Parameters

None.

Response Information

Resource Description

WebMethodResultOfListOfCommunicationRecipient

Name	Type	Additional information
Result	Collection of CommunicationRecipient	None.
Success	boolean	None.
ErrorText	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": [
    {
      "FamilyName": "sample string 1",
      "ChildrenNames": [
        "sample string 1",
        "sample string 2"
      ],
      "HouseHold1": {
        "HouseHoldId": 1,
        "DoNotContact": true,
        "Parent1": {
          "IsValidContact": true,
          "IsOptedIn": true,
          "PersonId": 2,
          "Name": {
            "FirstName": "sample string 1",
            "LastName": "sample string 2"
          }
        },
        "Parent2": {
          "IsValidContact": true,
          "IsOptedIn": true,
          "PersonId": 2,
          "Name": {
            "FirstName": "sample string 1",
            "LastName": "sample string 2"
          }
        }
      },
      "HouseHold2": {
        "HouseHoldId": 1,
        "DoNotContact": true,
        "Parent1": {
          "IsValidContact": true,
          "IsOptedIn": true,
          "PersonId": 2,
          "Name": {
            "FirstName": "sample string 1",
            "LastName": "sample string 2"
          }
        },
        "Parent2": {
          "IsValidContact": true,
          "IsOptedIn": true,
          "PersonId": 2,
          "Name": {
            "FirstName": "sample string 1",
            "LastName": "sample string 2"
          }
        }
      }
    },
    {
      "FamilyName": "sample string 1",
      "ChildrenNames": [
        "sample string 1",
        "sample string 2"
      ],
      "HouseHold1": {
        "HouseHoldId": 1,
        "DoNotContact": true,
        "Parent1": {
          "IsValidContact": true,
          "IsOptedIn": true,
          "PersonId": 2,
          "Name": {
            "FirstName": "sample string 1",
            "LastName": "sample string 2"
          }
        },
        "Parent2": {
          "IsValidContact": true,
          "IsOptedIn": true,
          "PersonId": 2,
          "Name": {
            "FirstName": "sample string 1",
            "LastName": "sample string 2"
          }
        }
      },
      "HouseHold2": {
        "HouseHoldId": 1,
        "DoNotContact": true,
        "Parent1": {
          "IsValidContact": true,
          "IsOptedIn": true,
          "PersonId": 2,
          "Name": {
            "FirstName": "sample string 1",
            "LastName": "sample string 2"
          }
        },
        "Parent2": {
          "IsValidContact": true,
          "IsOptedIn": true,
          "PersonId": 2,
          "Name": {
            "FirstName": "sample string 1",
            "LastName": "sample string 2"
          }
        }
      }
    }
  ],
  "Success": true,
  "ErrorText": "sample string 2"
}

application/javascript

Sample:

{"Result":[{"FamilyName":"sample string 1","ChildrenNames":["sample string 1","sample string 2"],"HouseHold1":{"HouseHoldId":1,"DoNotContact":true,"Parent1":{"IsValidContact":true,"IsOptedIn":true,"PersonId":2,"Name":{"FirstName":"sample string 1","LastName":"sample string 2"}},"Parent2":{"IsValidContact":true,"IsOptedIn":true,"PersonId":2,"Name":{"FirstName":"sample string 1","LastName":"sample string 2"}}},"HouseHold2":{"HouseHoldId":1,"DoNotContact":true,"Parent1":{"IsValidContact":true,"IsOptedIn":true,"PersonId":2,"Name":{"FirstName":"sample string 1","LastName":"sample string 2"}},"Parent2":{"IsValidContact":true,"IsOptedIn":true,"PersonId":2,"Name":{"FirstName":"sample string 1","LastName":"sample string 2"}}}},{"FamilyName":"sample string 1","ChildrenNames":["sample string 1","sample string 2"],"HouseHold1":{"HouseHoldId":1,"DoNotContact":true,"Parent1":{"IsValidContact":true,"IsOptedIn":true,"PersonId":2,"Name":{"FirstName":"sample string 1","LastName":"sample string 2"}},"Parent2":{"IsValidContact":true,"IsOptedIn":true,"PersonId":2,"Name":{"FirstName":"sample string 1","LastName":"sample string 2"}}},"HouseHold2":{"HouseHoldId":1,"DoNotContact":true,"Parent1":{"IsValidContact":true,"IsOptedIn":true,"PersonId":2,"Name":{"FirstName":"sample string 1","LastName":"sample string 2"}},"Parent2":{"IsValidContact":true,"IsOptedIn":true,"PersonId":2,"Name":{"FirstName":"sample string 1","LastName":"sample string 2"}}}}],"Success":true,"ErrorText":"sample string 2"}

application/xml, text/xml

Sample:

<WebMethodResultOfListOfCommunicationRecipient xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Success>true</Success>
  <ErrorText>sample string 2</ErrorText>
  <Result>
    <CommunicationRecipient>
      <FamilyName>sample string 1</FamilyName>
      <ChildrenNames>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </ChildrenNames>
      <HouseHold1>
        <HouseHoldId>1</HouseHoldId>
        <DoNotContact>true</DoNotContact>
        <Parent1>
          <PersonId>2</PersonId>
          <Name>
            <FirstName>sample string 1</FirstName>
            <LastName>sample string 2</LastName>
          </Name>
          <IsValidContact>true</IsValidContact>
          <IsOptedIn>true</IsOptedIn>
        </Parent1>
        <Parent2>
          <PersonId>2</PersonId>
          <Name>
            <FirstName>sample string 1</FirstName>
            <LastName>sample string 2</LastName>
          </Name>
          <IsValidContact>true</IsValidContact>
          <IsOptedIn>true</IsOptedIn>
        </Parent2>
      </HouseHold1>
      <HouseHold2>
        <HouseHoldId>1</HouseHoldId>
        <DoNotContact>true</DoNotContact>
        <Parent1>
          <PersonId>2</PersonId>
          <Name>
            <FirstName>sample string 1</FirstName>
            <LastName>sample string 2</LastName>
          </Name>
          <IsValidContact>true</IsValidContact>
          <IsOptedIn>true</IsOptedIn>
        </Parent1>
        <Parent2>
          <PersonId>2</PersonId>
          <Name>
            <FirstName>sample string 1</FirstName>
            <LastName>sample string 2</LastName>
          </Name>
          <IsValidContact>true</IsValidContact>
          <IsOptedIn>true</IsOptedIn>
        </Parent2>
      </HouseHold2>
    </CommunicationRecipient>
    <CommunicationRecipient>
      <FamilyName>sample string 1</FamilyName>
      <ChildrenNames>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </ChildrenNames>
      <HouseHold1>
        <HouseHoldId>1</HouseHoldId>
        <DoNotContact>true</DoNotContact>
        <Parent1>
          <PersonId>2</PersonId>
          <Name>
            <FirstName>sample string 1</FirstName>
            <LastName>sample string 2</LastName>
          </Name>
          <IsValidContact>true</IsValidContact>
          <IsOptedIn>true</IsOptedIn>
        </Parent1>
        <Parent2>
          <PersonId>2</PersonId>
          <Name>
            <FirstName>sample string 1</FirstName>
            <LastName>sample string 2</LastName>
          </Name>
          <IsValidContact>true</IsValidContact>
          <IsOptedIn>true</IsOptedIn>
        </Parent2>
      </HouseHold1>
      <HouseHold2>
        <HouseHoldId>1</HouseHoldId>
        <DoNotContact>true</DoNotContact>
        <Parent1>
          <PersonId>2</PersonId>
          <Name>
            <FirstName>sample string 1</FirstName>
            <LastName>sample string 2</LastName>
          </Name>
          <IsValidContact>true</IsValidContact>
          <IsOptedIn>true</IsOptedIn>
        </Parent1>
        <Parent2>
          <PersonId>2</PersonId>
          <Name>
            <FirstName>sample string 1</FirstName>
            <LastName>sample string 2</LastName>
          </Name>
          <IsValidContact>true</IsValidContact>
          <IsOptedIn>true</IsOptedIn>
        </Parent2>
      </HouseHold2>
    </CommunicationRecipient>
  </Result>
</WebMethodResultOfListOfCommunicationRecipient>