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

"use strict";
/** @typedef {number} */
export var DeliveryChannel;
(function (DeliveryChannel) {
    DeliveryChannel[DeliveryChannel["None"] = 0] = "None"
    DeliveryChannel[DeliveryChannel["Email"] = 1] = "Email"
    DeliveryChannel[DeliveryChannel["Sms"] = 2] = "Sms"
})(DeliveryChannel || (DeliveryChannel = {}));
export class Campaign {
    /** @param {{CampaignId?:number,CampaignTypeId?:number,CampaignName?:string,AgentID?:number,Subject?:string,Template?:string,DateCreated?:string,DateDeleted?:string,Frequency?:string,StartDate?:string,TimeOfDay?:string,LastRunAtUtc?:string,NextRunAtUtc?:string,TimeZoneId?:string,DayOfWeek?:DayOfWeek,DayOfMonth?:number,IsActive?:boolean,CreatedUtc?:string,UpdatedUtc?:string,Channels?:DeliveryChannel}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CampaignId;
    /** @type {number} */
    CampaignTypeId;
    /** @type {string} */
    CampaignName;
    /** @type {number} */
    AgentID;
    /** @type {string} */
    Subject;
    /** @type {string} */
    Template;
    /** @type {?string} */
    DateCreated;
    /** @type {?string} */
    DateDeleted;
    /** @type {string} */
    Frequency;
    /** @type {string} */
    StartDate;
    /** @type {?string} */
    TimeOfDay;
    /** @type {?string} */
    LastRunAtUtc;
    /** @type {?string} */
    NextRunAtUtc;
    /** @type {string} */
    TimeZoneId;
    /** @type {?DayOfWeek} */
    DayOfWeek;
    /** @type {?number} */
    DayOfMonth;
    /** @type {boolean} */
    IsActive;
    /** @type {?string} */
    CreatedUtc;
    /** @type {?string} */
    UpdatedUtc;
    /** @type {DeliveryChannel} */
    Channels;
}
export class CampaignExtended extends Campaign {
    /** @param {{CampaignType?:string,AgentName?:string,CampaignId?:number,CampaignTypeId?:number,CampaignName?:string,AgentID?:number,Subject?:string,Template?:string,DateCreated?:string,DateDeleted?:string,Frequency?:string,StartDate?:string,TimeOfDay?:string,LastRunAtUtc?:string,NextRunAtUtc?:string,TimeZoneId?:string,DayOfWeek?:DayOfWeek,DayOfMonth?:number,IsActive?:boolean,CreatedUtc?:string,UpdatedUtc?:string,Channels?:DeliveryChannel}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    CampaignType;
    /** @type {string} */
    AgentName;
}
export class CampaignResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Campaign?:CampaignExtended[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {CampaignExtended[]} */
    Campaign = [];
}
export class CampaignRequest {
    /** @param {{CampaignId?:number,Campaign?:Campaign[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CampaignId;
    /** @type {Campaign[]} */
    Campaign = [];
}

JavaScript 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>