| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,POST,PUT,DELETE,OPTIONS | /v1/Campaign/{CampaignId} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/Campaign |
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;
namespace CRM.AgencyPlatform.API.Internal
{
public partial class Campaign
{
public virtual int CampaignId { get; set; }
public virtual int CampaignTypeId { get; set; }
public virtual string CampaignName { get; set; }
public virtual int AgentID { get; set; }
public virtual string Subject { get; set; }
public virtual string Template { get; set; }
public virtual DateTime? DateCreated { get; set; }
public virtual DateTime? DateDeleted { get; set; }
public virtual string Frequency { get; set; }
public virtual DateTime StartDate { get; set; }
public virtual TimeSpan? TimeOfDay { get; set; }
public virtual DateTime? LastRunAtUtc { get; set; }
public virtual DateTime? NextRunAtUtc { get; set; }
public virtual string TimeZoneId { get; set; }
public virtual DayOfWeek? DayOfWeek { get; set; }
public virtual byte? DayOfMonth { get; set; }
public virtual bool IsActive { get; set; }
public virtual DateTime? CreatedUtc { get; set; }
public virtual DateTime? UpdatedUtc { get; set; }
public virtual DeliveryChannel Channels { get; set; }
}
public partial class CampaignExtended
: Campaign
{
public virtual string CampaignType { get; set; }
public virtual string AgentName { get; set; }
}
public partial class CampaignRequest
{
public virtual int CampaignId { get; set; }
public virtual List<Campaign> Campaign { get; set; } = [];
}
public partial class CampaignResponse
{
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual List<CampaignExtended> Campaign { get; set; } = [];
}
[Flags]
public enum DeliveryChannel
{
None = 0,
Email = 1,
Sms = 2,
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
]
}