digitaluapi

<back to all web services

StartCampaignCommunications

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET POST/campaign/communications/start/{ScheduleInstancesId}Get Campaign Communications
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class StartCampaignCommunications
    {
        @DataMember(Order=1)
        public Long ScheduleInstancesId = null;

        @DataMember(Order=2)
        public Integer NoOfRecords = null;

        @DataMember(Order=3)
        public ArrayList<Integer> Channels = null;
        
        public Long getScheduleInstancesId() { return ScheduleInstancesId; }
        public StartCampaignCommunications setScheduleInstancesId(Long value) { this.ScheduleInstancesId = value; return this; }
        public Integer getNoOfRecords() { return NoOfRecords; }
        public StartCampaignCommunications setNoOfRecords(Integer value) { this.NoOfRecords = value; return this; }
        public ArrayList<Integer> getChannels() { return Channels; }
        public StartCampaignCommunications setChannels(ArrayList<Integer> value) { this.Channels = value; return this; }
    }

}

Java StartCampaignCommunications 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 /campaign/communications/start/{ScheduleInstancesId} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<StartCampaignCommunications xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Channels xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </Channels>
  <NoOfRecords>0</NoOfRecords>
  <ScheduleInstancesId>0</ScheduleInstancesId>
</StartCampaignCommunications>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">false</boolean>