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

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

}

C# 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>