Trendsic Platform Service

<back to all web services

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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class CampaignRequest
    {
        public Integer CampaignId = null;
        public ArrayList<Campaign> Campaign = new ArrayList<Campaign>();
        
        public Integer getCampaignId() { return CampaignId; }
        public CampaignRequest setCampaignId(Integer value) { this.CampaignId = value; return this; }
        public ArrayList<Campaign> getCampaign() { return Campaign; }
        public CampaignRequest setCampaign(ArrayList<Campaign> value) { this.Campaign = value; return this; }
    }

    public static class Campaign
    {
        public Integer CampaignId = null;
        public Integer CampaignTypeId = null;
        public String CampaignName = null;
        public Integer AgentID = null;
        public String Subject = null;
        public String Template = null;
        public Date DateCreated = null;
        public Date DateDeleted = null;
        public String Frequency = null;
        public Date StartDate = null;
        public TimeSpan TimeOfDay = null;
        public Date LastRunAtUtc = null;
        public Date NextRunAtUtc = null;
        public String TimeZoneId = null;
        public DayOfWeek DayOfWeek = null;
        public Short DayOfMonth = null;
        public Boolean IsActive = null;
        public Date CreatedUtc = null;
        public Date UpdatedUtc = null;
        public DeliveryChannel Channels = null;
        
        public Integer getCampaignId() { return CampaignId; }
        public Campaign setCampaignId(Integer value) { this.CampaignId = value; return this; }
        public Integer getCampaignTypeId() { return CampaignTypeId; }
        public Campaign setCampaignTypeId(Integer value) { this.CampaignTypeId = value; return this; }
        public String getCampaignName() { return CampaignName; }
        public Campaign setCampaignName(String value) { this.CampaignName = value; return this; }
        public Integer getAgentID() { return AgentID; }
        public Campaign setAgentID(Integer value) { this.AgentID = value; return this; }
        public String getSubject() { return Subject; }
        public Campaign setSubject(String value) { this.Subject = value; return this; }
        public String getTemplate() { return Template; }
        public Campaign setTemplate(String value) { this.Template = value; return this; }
        public Date getDateCreated() { return DateCreated; }
        public Campaign setDateCreated(Date value) { this.DateCreated = value; return this; }
        public Date getDateDeleted() { return DateDeleted; }
        public Campaign setDateDeleted(Date value) { this.DateDeleted = value; return this; }
        public String getFrequency() { return Frequency; }
        public Campaign setFrequency(String value) { this.Frequency = value; return this; }
        public Date getStartDate() { return StartDate; }
        public Campaign setStartDate(Date value) { this.StartDate = value; return this; }
        public TimeSpan getTimeOfDay() { return TimeOfDay; }
        public Campaign setTimeOfDay(TimeSpan value) { this.TimeOfDay = value; return this; }
        public Date getLastRunAtUtc() { return LastRunAtUtc; }
        public Campaign setLastRunAtUtc(Date value) { this.LastRunAtUtc = value; return this; }
        public Date getNextRunAtUtc() { return NextRunAtUtc; }
        public Campaign setNextRunAtUtc(Date value) { this.NextRunAtUtc = value; return this; }
        public String getTimeZoneId() { return TimeZoneId; }
        public Campaign setTimeZoneId(String value) { this.TimeZoneId = value; return this; }
        public DayOfWeek getDayOfWeek() { return DayOfWeek; }
        public Campaign setDayOfWeek(DayOfWeek value) { this.DayOfWeek = value; return this; }
        public Short getDayOfMonth() { return DayOfMonth; }
        public Campaign setDayOfMonth(Short value) { this.DayOfMonth = value; return this; }
        public Boolean getIsActive() { return IsActive; }
        public Campaign setIsActive(Boolean value) { this.IsActive = value; return this; }
        public Date getCreatedUtc() { return CreatedUtc; }
        public Campaign setCreatedUtc(Date value) { this.CreatedUtc = value; return this; }
        public Date getUpdatedUtc() { return UpdatedUtc; }
        public Campaign setUpdatedUtc(Date value) { this.UpdatedUtc = value; return this; }
        public DeliveryChannel getChannels() { return Channels; }
        public Campaign setChannels(DeliveryChannel value) { this.Channels = value; return this; }
    }

    @Flags()
    public static enum DeliveryChannel
    {
        @SerializedName("0") None(0),
        @SerializedName("1") Email(1),
        @SerializedName("2") Sms(2);

        private final int value;
        DeliveryChannel(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

    public static class CampaignResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<CampaignExtended> Campaign = new ArrayList<CampaignExtended>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public CampaignResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<CampaignExtended> getCampaign() { return Campaign; }
        public CampaignResponse setCampaign(ArrayList<CampaignExtended> value) { this.Campaign = value; return this; }
    }

    public static class CampaignExtended extends Campaign
    {
        public String CampaignType = null;
        public String AgentName = null;
        
        public String getCampaignType() { return CampaignType; }
        public CampaignExtended setCampaignType(String value) { this.CampaignType = value; return this; }
        public String getAgentName() { return AgentName; }
        public CampaignExtended setAgentName(String value) { this.AgentName = value; return this; }
    }

}

Java CampaignRequest DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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/jsonl
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}]}