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

**CampaignRequest** Parameters:
Name	Parameter	Data Type	Required	Description
CampaignId	path	int	No
Campaign	body	List<Campaign>	No

**Campaign** Parameters:
Name	Parameter	Data Type	Required
CampaignId	form	int	No
CampaignTypeId	form	int	No
CampaignName	form	string	No
AgentID	form	int	No
Subject	form	string	No
Template	form	string	No
DateCreated	form	DateTime?	No
DateDeleted	form	DateTime?	No
Frequency	form	string	No
StartDate	form	DateTime	No
TimeOfDay	form	TimeSpan?	No
LastRunAtUtc	form	DateTime?	No
NextRunAtUtc	form	DateTime?	No
TimeZoneId	form	string	No
DayOfWeek	form	DayOfWeek?	No
DayOfMonth	form	byte?	No
IsActive	form	bool	No
CreatedUtc	form	DateTime?	No
UpdatedUtc	form	DateTime?	No
Channels	form	DeliveryChannel	No

**DeliveryChannel** Enum:
Name	Value
None	0
Email	1
Sms	2

**CampaignResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Campaign	form	List<CampaignExtended>	No

**CampaignExtended** Parameters:
Name	Parameter	Data Type	Required	Description
CampaignType	form	string	No
AgentName	form	string	No

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
		}
	]
}