digitaluapi

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

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class StartCampaignCommunications implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var int|null */
        public ?int $ScheduleInstancesId=null,

        // @DataMember(Order=2)
        /** @var int */
        public int $NoOfRecords=0,

        // @DataMember(Order=3)
        /** @var int[]|null */
        public ?array $Channels=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ScheduleInstancesId'])) $this->ScheduleInstancesId = $o['ScheduleInstancesId'];
        if (isset($o['NoOfRecords'])) $this->NoOfRecords = $o['NoOfRecords'];
        if (isset($o['Channels'])) $this->Channels = JsonConverters::fromArray('int', $o['Channels']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ScheduleInstancesId)) $o['ScheduleInstancesId'] = $this->ScheduleInstancesId;
        if (isset($this->NoOfRecords)) $o['NoOfRecords'] = $this->NoOfRecords;
        if (isset($this->Channels)) $o['Channels'] = JsonConverters::toArray('int', $this->Channels);
        return empty($o) ? new class(){} : $o;
    }
}

PHP StartCampaignCommunications DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"ScheduleInstancesId":0,"NoOfRecords":0,"Channels":[0]}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

false