GET api/communication/text/IndividualRecipients?filterSetID={filterSetID}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
filterSetID | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
WebMethodResultOfListOfTextRecipientName | Description | Type | Additional information |
---|---|---|---|
Result | Collection of TextRecipient |
None. |
|
Success | boolean |
None. |
|
ErrorText | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Result": [ { "CellPhone": "sample string 1", "IsValidContact": true, "IsOptedIn": true, "PersonId": 3, "Name": { "FirstName": "sample string 1", "LastName": "sample string 2" } }, { "CellPhone": "sample string 1", "IsValidContact": true, "IsOptedIn": true, "PersonId": 3, "Name": { "FirstName": "sample string 1", "LastName": "sample string 2" } } ], "Success": true, "ErrorText": "sample string 2" }
application/javascript
Sample:
{"Result":[{"CellPhone":"sample string 1","IsValidContact":true,"IsOptedIn":true,"PersonId":3,"Name":{"FirstName":"sample string 1","LastName":"sample string 2"}},{"CellPhone":"sample string 1","IsValidContact":true,"IsOptedIn":true,"PersonId":3,"Name":{"FirstName":"sample string 1","LastName":"sample string 2"}}],"Success":true,"ErrorText":"sample string 2"}
application/xml, text/xml
Sample:
<WebMethodResultOfListOfTextRecipient 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> <TextRecipient> <PersonId>3</PersonId> <Name> <FirstName>sample string 1</FirstName> <LastName>sample string 2</LastName> </Name> <CellPhone>sample string 1</CellPhone> <IsValidContact>true</IsValidContact> <IsOptedIn>true</IsOptedIn> </TextRecipient> <TextRecipient> <PersonId>3</PersonId> <Name> <FirstName>sample string 1</FirstName> <LastName>sample string 2</LastName> </Name> <CellPhone>sample string 1</CellPhone> <IsValidContact>true</IsValidContact> <IsOptedIn>true</IsOptedIn> </TextRecipient> </Result> </WebMethodResultOfListOfTextRecipient>