Trendsic Platform Service

<back to all web services

CampaignRecipientsRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/campaigns/{Id}/runs/{RunId}/recipients
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class CampaignRecipientsRequest
    {
        public Integer Id = null;
        public Integer RunId = null;
        public String Status = null;
        public String Channel = null;
        public String Q = null;
        public Integer Page = null;
        public Integer Size = null;
        public String Sort = null;
        public String Dir = null;
        
        public Integer getId() { return Id; }
        public CampaignRecipientsRequest setId(Integer value) { this.Id = value; return this; }
        public Integer getRunId() { return RunId; }
        public CampaignRecipientsRequest setRunId(Integer value) { this.RunId = value; return this; }
        public String getStatus() { return Status; }
        public CampaignRecipientsRequest setStatus(String value) { this.Status = value; return this; }
        public String getChannel() { return Channel; }
        public CampaignRecipientsRequest setChannel(String value) { this.Channel = value; return this; }
        public String getQ() { return Q; }
        public CampaignRecipientsRequest setQ(String value) { this.Q = value; return this; }
        public Integer getPage() { return Page; }
        public CampaignRecipientsRequest setPage(Integer value) { this.Page = value; return this; }
        public Integer getSize() { return Size; }
        public CampaignRecipientsRequest setSize(Integer value) { this.Size = value; return this; }
        public String getSort() { return Sort; }
        public CampaignRecipientsRequest setSort(String value) { this.Sort = value; return this; }
        public String getDir() { return Dir; }
        public CampaignRecipientsRequest setDir(String value) { this.Dir = value; return this; }
    }

    public static class CampaignJsonResponse
    {
        public ResponseStatus ResponseStatus = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public CampaignJsonResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java CampaignRecipientsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/campaigns/{Id}/runs/{RunId}/recipients HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CampaignJsonResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CampaignJsonResponse>