| 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 |
namespace CRM.AgencyPlatform.API.Internal
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<Flags>]
type DeliveryChannel =
| None = 0
| Email = 1
| Sms = 2
[<AllowNullLiteral>]
type Campaign() =
member val CampaignId:Int32 = new Int32() with get,set
member val CampaignTypeId:Int32 = new Int32() with get,set
member val CampaignName:String = null with get,set
member val AgentID:Int32 = new Int32() with get,set
member val Subject:String = null with get,set
member val Template:String = null with get,set
member val DateCreated:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val DateDeleted:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val Frequency:String = null with get,set
member val StartDate:DateTime = new DateTime() with get,set
member val TimeOfDay:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
member val LastRunAtUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val NextRunAtUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val TimeZoneId:String = null with get,set
member val DayOfWeek:Nullable<DayOfWeek> = new Nullable<DayOfWeek>() with get,set
member val DayOfMonth:Nullable<Byte> = new Nullable<Byte>() with get,set
member val IsActive:Boolean = new Boolean() with get,set
member val CreatedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val UpdatedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val Channels:DeliveryChannel = new DeliveryChannel() with get,set
[<AllowNullLiteral>]
type CampaignExtended() =
inherit Campaign()
member val CampaignType:String = null with get,set
member val AgentName:String = null with get,set
[<AllowNullLiteral>]
type CampaignResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val Campaign:ResizeArray<CampaignExtended> = new ResizeArray<CampaignExtended>() with get,set
[<AllowNullLiteral>]
type CampaignRequest() =
member val CampaignId:Int32 = new Int32() with get,set
member val Campaign:ResizeArray<Campaign> = new ResizeArray<Campaign>() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
Content-Length: length
{"CampaignId":0,"Campaign":[{"CampaignId":0,"CampaignTypeId":0,"CampaignName":"String","AgentID":0,"Subject":"String","Template":"String","DateCreated":"0001-01-01T00:00:00.0000000","DateDeleted":"0001-01-01T00:00:00.0000000","Frequency":"String","StartDate":"0001-01-01T00:00:00.0000000","TimeOfDay":"PT0S","LastRunAtUtc":"0001-01-01T00:00:00.0000000","NextRunAtUtc":"0001-01-01T00:00:00.0000000","TimeZoneId":"String","DayOfWeek":"Sunday","DayOfMonth":0,"IsActive":false,"CreatedUtc":"0001-01-01T00:00:00.0000000","UpdatedUtc":"0001-01-01T00:00:00.0000000","Channels":0}]}
HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","DateDeleted":"0001-01-01T00:00:00.0000000","Frequency":"String","StartDate":"0001-01-01T00:00:00.0000000","TimeOfDay":"PT0S","LastRunAtUtc":"0001-01-01T00:00:00.0000000","NextRunAtUtc":"0001-01-01T00:00:00.0000000","TimeZoneId":"String","DayOfWeek":"Sunday","DayOfMonth":0,"IsActive":false,"CreatedUtc":"0001-01-01T00:00:00.0000000","UpdatedUtc":"0001-01-01T00:00:00.0000000","Channels":0}]}