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

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

Swift CampaignRequest DTOs

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

HTTP + XML

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

<CampaignRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Campaign>
    <Campaign>
      <AgentID>0</AgentID>
      <CampaignId>0</CampaignId>
      <CampaignName>String</CampaignName>
      <CampaignTypeId>0</CampaignTypeId>
      <Channels>None</Channels>
      <CreatedUtc>0001-01-01T00:00:00</CreatedUtc>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DateDeleted>0001-01-01T00:00:00</DateDeleted>
      <DayOfMonth>0</DayOfMonth>
      <DayOfWeek>Sunday</DayOfWeek>
      <Frequency>String</Frequency>
      <IsActive>false</IsActive>
      <LastRunAtUtc>0001-01-01T00:00:00</LastRunAtUtc>
      <NextRunAtUtc>0001-01-01T00:00:00</NextRunAtUtc>
      <StartDate>0001-01-01T00:00:00</StartDate>
      <Subject>String</Subject>
      <Template>String</Template>
      <TimeOfDay>PT0S</TimeOfDay>
      <TimeZoneId>String</TimeZoneId>
      <UpdatedUtc>0001-01-01T00:00:00</UpdatedUtc>
    </Campaign>
  </Campaign>
  <CampaignId>0</CampaignId>
</CampaignRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CampaignResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Campaign>
    <CampaignExtended>
      <AgentID>0</AgentID>
      <CampaignId>0</CampaignId>
      <CampaignName>String</CampaignName>
      <CampaignTypeId>0</CampaignTypeId>
      <Channels>None</Channels>
      <CreatedUtc>0001-01-01T00:00:00</CreatedUtc>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DateDeleted>0001-01-01T00:00:00</DateDeleted>
      <DayOfMonth>0</DayOfMonth>
      <DayOfWeek>Sunday</DayOfWeek>
      <Frequency>String</Frequency>
      <IsActive>false</IsActive>
      <LastRunAtUtc>0001-01-01T00:00:00</LastRunAtUtc>
      <NextRunAtUtc>0001-01-01T00:00:00</NextRunAtUtc>
      <StartDate>0001-01-01T00:00:00</StartDate>
      <Subject>String</Subject>
      <Template>String</Template>
      <TimeOfDay>PT0S</TimeOfDay>
      <TimeZoneId>String</TimeZoneId>
      <UpdatedUtc>0001-01-01T00:00:00</UpdatedUtc>
      <AgentName>String</AgentName>
      <CampaignType>String</CampaignType>
    </CampaignExtended>
  </Campaign>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CampaignResponse>