Trendsic Platform Service

MassCommunicationContactRequest

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

The following routes are available for this service:
POST,OPTIONS	/v1/MassCommunicationContact

<?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 MassCommunicationResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var bool|null */
        public ?bool $Success=null,
        /** @var int */
        public int $Recipients=0
    ) {
    }

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

class MassCommunicationContactRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Subject=null,
        /** @var string|null */
        public ?string $Message=null,
        /** @var array<string>|null */
        public ?array $Recipients=null,
        /** @var array<string>|null */
        public ?array $Locations=null,
        /** @var bool|null */
        public ?bool $EmailMissingNumbers=null,
        /** @var bool|null */
        public ?bool $EmailAll=null,
        /** @var bool|null */
        public ?bool $SMSAll=null,
        /** @var string|null */
        public ?string $ContactCategories=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Subject'])) $this->Subject = $o['Subject'];
        if (isset($o['Message'])) $this->Message = $o['Message'];
        if (isset($o['Recipients'])) $this->Recipients = JsonConverters::fromArray('string', $o['Recipients']);
        if (isset($o['Locations'])) $this->Locations = JsonConverters::fromArray('string', $o['Locations']);
        if (isset($o['EmailMissingNumbers'])) $this->EmailMissingNumbers = $o['EmailMissingNumbers'];
        if (isset($o['EmailAll'])) $this->EmailAll = $o['EmailAll'];
        if (isset($o['SMSAll'])) $this->SMSAll = $o['SMSAll'];
        if (isset($o['ContactCategories'])) $this->ContactCategories = $o['ContactCategories'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Subject)) $o['Subject'] = $this->Subject;
        if (isset($this->Message)) $o['Message'] = $this->Message;
        if (isset($this->Recipients)) $o['Recipients'] = JsonConverters::toArray('string', $this->Recipients);
        if (isset($this->Locations)) $o['Locations'] = JsonConverters::toArray('string', $this->Locations);
        if (isset($this->EmailMissingNumbers)) $o['EmailMissingNumbers'] = $this->EmailMissingNumbers;
        if (isset($this->EmailAll)) $o['EmailAll'] = $this->EmailAll;
        if (isset($this->SMSAll)) $o['SMSAll'] = $this->SMSAll;
        if (isset($this->ContactCategories)) $o['ContactCategories'] = $this->ContactCategories;
        return empty($o) ? new class(){} : $o;
    }
}

PHP MassCommunicationContactRequest DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/MassCommunicationContact HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Subject":"String","Message":"String","Recipients":["String"],"Locations":["String"],"EmailMissingNumbers":false,"EmailAll":false,"SMSAll":false,"ContactCategories":"String"}

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"}},"Success":false,"Recipients":0}