Trendsic Platform Service

<back to all web services

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:
NameParameterData TypeRequiredDescription
CampaignIdpathintNo
CampaignbodyList<Campaign>No
Campaign Parameters:
NameParameterData TypeRequiredDescription
CampaignIdformintNo
CampaignTypeIdformintNo
CampaignNameformstringNo
AgentIDformintNo
SubjectformstringNo
TemplateformstringNo
DateCreatedformDateTime?No
DateDeletedformDateTime?No
FrequencyformstringNo
StartDateformDateTimeNo
TimeOfDayformTimeSpan?No
LastRunAtUtcformDateTime?No
NextRunAtUtcformDateTime?No
TimeZoneIdformstringNo
DayOfWeekformDayOfWeek?No
DayOfMonthformbyte?No
IsActiveformboolNo
CreatedUtcformDateTime?No
UpdatedUtcformDateTime?No
ChannelsformDeliveryChannelNo
DeliveryChannel Enum:
NameValue
None0
Email1
Sms2
CampaignResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
CampaignformList<CampaignExtended>No
CampaignExtended Parameters:
NameParameterData TypeRequiredDescription
CampaignTypeformstringNo
AgentNameformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","DateDeleted":"0001-01-01T00:00:00.0000000","Frequency":"String","StartDate":"0001-01-01T00:00:00.0000000","TimeOfDay":"PT0S","LastRunAtUtc":"0001-01-01T00:00:00.0000000","NextRunAtUtc":"0001-01-01T00:00:00.0000000","TimeZoneId":"String","DayOfWeek":"Sunday","DayOfMonth":0,"IsActive":false,"CreatedUtc":"0001-01-01T00:00:00.0000000","UpdatedUtc":"0001-01-01T00:00:00.0000000","Channels":0}]}