Trendsic Platform Service

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

"use strict";
export class CampaignJsonResponse {
    /** @param {{ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class CampaignRecipientsRequest {
    /** @param {{Id?:number,RunId?:number,Status?:string,Channel?:string,Q?:string,Page?:number,Size?:number,Sort?:string,Dir?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    RunId;
    /** @type {string} */
    Status;
    /** @type {string} */
    Channel;
    /** @type {string} */
    Q;
    /** @type {number} */
    Page;
    /** @type {number} */
    Size;
    /** @type {string} */
    Sort;
    /** @type {string} */
    Dir;
}

JavaScript CampaignRecipientsRequest DTOs

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

HTTP + JSV

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: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}