Trendsic Platform Service

CampaignRecipientsRequest

**Requires Authentication**
Requires any of the roles:	Worker, Agent, Administrator

The following routes are available for this service:
GET,OPTIONS	/v1/campaigns/{Id}/runs/{RunId}/recipients

<?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 CampaignJsonResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class CampaignRecipientsRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Id=0,
        /** @var int */
        public int $RunId=0,
        /** @var string|null */
        public ?string $Status=null,
        /** @var string|null */
        public ?string $Channel=null,
        /** @var string|null */
        public ?string $Q=null,
        /** @var int */
        public int $Page=0,
        /** @var int */
        public int $Size=0,
        /** @var string|null */
        public ?string $Sort=null,
        /** @var string|null */
        public ?string $Dir=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['RunId'])) $this->RunId = $o['RunId'];
        if (isset($o['Status'])) $this->Status = $o['Status'];
        if (isset($o['Channel'])) $this->Channel = $o['Channel'];
        if (isset($o['Q'])) $this->Q = $o['Q'];
        if (isset($o['Page'])) $this->Page = $o['Page'];
        if (isset($o['Size'])) $this->Size = $o['Size'];
        if (isset($o['Sort'])) $this->Sort = $o['Sort'];
        if (isset($o['Dir'])) $this->Dir = $o['Dir'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->RunId)) $o['RunId'] = $this->RunId;
        if (isset($this->Status)) $o['Status'] = $this->Status;
        if (isset($this->Channel)) $o['Channel'] = $this->Channel;
        if (isset($this->Q)) $o['Q'] = $this->Q;
        if (isset($this->Page)) $o['Page'] = $this->Page;
        if (isset($this->Size)) $o['Size'] = $this->Size;
        if (isset($this->Sort)) $o['Sort'] = $this->Sort;
        if (isset($this->Dir)) $o['Dir'] = $this->Dir;
        return empty($o) ? new class(){} : $o;
    }
}

PHP CampaignRecipientsRequest 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.

GET /v1/campaigns/{Id}/runs/{RunId}/recipients HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl

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"}}}