| 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 |
import Foundation
import ServiceStack
public class CampaignRequest : Codable
{
public var campaignId:Int
public var campaign:[Campaign] = []
required public init(){}
}
public class Campaign : Codable
{
public var campaignId:Int
public var campaignTypeId:Int
public var campaignName:String
public var agentID:Int
public var subject:String
public var template:String
public var dateCreated:Date?
public var dateDeleted:Date?
public var frequency:String
public var startDate:Date
@TimeSpan public var timeOfDay:TimeInterval?
public var lastRunAtUtc:Date?
public var nextRunAtUtc:Date?
public var timeZoneId:String
public var dayOfWeek:DayOfWeek?
public var dayOfMonth:UInt8?
public var isActive:Bool
public var createdUtc:Date?
public var updatedUtc:Date?
public var channels:DeliveryChannel
required public init(){}
}
// @Flags()
public enum DeliveryChannel : Int, Codable
{
case None = 0
case Email = 1
case Sms = 2
}
public class CampaignResponse : Codable
{
public var responseStatus:ResponseStatus
public var campaign:[CampaignExtended] = []
required public init(){}
}
public class CampaignExtended : Campaign
{
public var campaignType:String
public var agentName:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case campaignType
case agentName
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
campaignType = try container.decodeIfPresent(String.self, forKey: .campaignType)
agentName = try container.decodeIfPresent(String.self, forKey: .agentName)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if campaignType != nil { try container.encode(campaignType, forKey: .campaignType) }
if agentName != nil { try container.encode(agentName, forKey: .agentName) }
}
}
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
}
]
}