Trendsic Platform Service

CampaignRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator, Agent, Administrator, Agent, Administrator

The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS	/v1/Campaign/{CampaignId}
GET,POST,PUT,DELETE,OPTIONS	/v1/Campaign


// @Flags()
export enum DeliveryChannel
{
    None = 0,
    Email = 1,
    Sms = 2,
}

export class Campaign
{
    public CampaignId: number;
    public CampaignTypeId: number;
    public CampaignName: string;
    public AgentID: number;
    public Subject: string;
    public Template: string;
    public DateCreated?: string;
    public DateDeleted?: string;
    public Frequency: string;
    public StartDate: string;
    public TimeOfDay?: string;
    public LastRunAtUtc?: string;
    public NextRunAtUtc?: string;
    public TimeZoneId: string;
    public DayOfWeek?: DayOfWeek;
    public DayOfMonth?: number;
    public IsActive: boolean;
    public CreatedUtc?: string;
    public UpdatedUtc?: string;
    public Channels: DeliveryChannel;

    public constructor(init?: Partial<Campaign>) { (Object as any).assign(this, init); }
}

export class CampaignExtended extends Campaign
{
    public CampaignType: string;
    public AgentName: string;

    public constructor(init?: Partial<CampaignExtended>) { super(init); (Object as any).assign(this, init); }
}

export class CampaignResponse
{
    public ResponseStatus: ResponseStatus;
    public Campaign: CampaignExtended[] = [];

    public constructor(init?: Partial<CampaignResponse>) { (Object as any).assign(this, init); }
}

export class CampaignRequest
{
    public CampaignId: number;
    public Campaign: Campaign[] = [];

    public constructor(init?: Partial<CampaignRequest>) { (Object as any).assign(this, init); }
}

TypeScript CampaignRequest 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.

POST /v1/Campaign/{CampaignId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CampaignId: 0,
	Campaign: 
	[
		{
			CampaignId: 0,
			CampaignTypeId: 0,
			CampaignName: String,
			AgentID: 0,
			Subject: String,
			Template: String,
			DateCreated: 0001-01-01,
			DateDeleted: 0001-01-01,
			Frequency: String,
			StartDate: 0001-01-01,
			TimeOfDay: PT0S,
			LastRunAtUtc: 0001-01-01,
			NextRunAtUtc: 0001-01-01,
			TimeZoneId: String,
			DayOfWeek: Sunday,
			DayOfMonth: 0,
			IsActive: False,
			CreatedUtc: 0001-01-01,
			UpdatedUtc: 0001-01-01,
			Channels: 0
		}
	]
}

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
		}
	},
	Campaign: 
	[
		{
			CampaignType: String,
			AgentName: String,
			CampaignId: 0,
			CampaignTypeId: 0,
			CampaignName: String,
			AgentID: 0,
			Subject: String,
			Template: String,
			DateCreated: 0001-01-01,
			DateDeleted: 0001-01-01,
			Frequency: String,
			StartDate: 0001-01-01,
			TimeOfDay: PT0S,
			LastRunAtUtc: 0001-01-01,
			NextRunAtUtc: 0001-01-01,
			TimeZoneId: String,
			DayOfWeek: Sunday,
			DayOfMonth: 0,
			IsActive: False,
			CreatedUtc: 0001-01-01,
			UpdatedUtc: 0001-01-01,
			Channels: 0
		}
	]
}