Trendsic Platform Service

<back to all web services

CampaignTemplateRequest

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/CampaignTemplate/{CampaignTemplateId}
GET,POST,PUT,DELETE,OPTIONS/v1/CampaignTemplate
<?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 CampaignTemplate implements JsonSerializable
{
    public function __construct(
        /** @var DateTime|null */
        public ?DateTime $DateCreated=null,
        /** @var DateTime|null */
        public ?DateTime $DateDeleted=null,
        /** @var int */
        public int $CampaignTemplateId=0,
        /** @var string|null */
        public ?string $TemplateName=null,
        /** @var int */
        public int $CampaignTypeId=0,
        /** @var string|null */
        public ?string $Template=null,
        /** @var string|null */
        public ?string $Image=null,
        /** @var string|null */
        public ?string $Thumbnail=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['DateCreated'])) $this->DateCreated = JsonConverters::from('DateTime', $o['DateCreated']);
        if (isset($o['DateDeleted'])) $this->DateDeleted = JsonConverters::from('DateTime', $o['DateDeleted']);
        if (isset($o['CampaignTemplateId'])) $this->CampaignTemplateId = $o['CampaignTemplateId'];
        if (isset($o['TemplateName'])) $this->TemplateName = $o['TemplateName'];
        if (isset($o['CampaignTypeId'])) $this->CampaignTypeId = $o['CampaignTypeId'];
        if (isset($o['Template'])) $this->Template = $o['Template'];
        if (isset($o['Image'])) $this->Image = $o['Image'];
        if (isset($o['Thumbnail'])) $this->Thumbnail = $o['Thumbnail'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->DateCreated)) $o['DateCreated'] = JsonConverters::to('DateTime', $this->DateCreated);
        if (isset($this->DateDeleted)) $o['DateDeleted'] = JsonConverters::to('DateTime', $this->DateDeleted);
        if (isset($this->CampaignTemplateId)) $o['CampaignTemplateId'] = $this->CampaignTemplateId;
        if (isset($this->TemplateName)) $o['TemplateName'] = $this->TemplateName;
        if (isset($this->CampaignTypeId)) $o['CampaignTypeId'] = $this->CampaignTypeId;
        if (isset($this->Template)) $o['Template'] = $this->Template;
        if (isset($this->Image)) $o['Image'] = $this->Image;
        if (isset($this->Thumbnail)) $o['Thumbnail'] = $this->Thumbnail;
        return empty($o) ? new class(){} : $o;
    }
}

class CampaignTemplateResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<CampaignTemplate>|null */
        public ?array $CampaignTemplate=null
    ) {
    }

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

class CampaignTemplateRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $CampaignTemplateId=0,
        /** @var array<CampaignTemplate>|null */
        public ?array $CampaignTemplate=null
    ) {
    }

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

PHP CampaignTemplateRequest 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 /v1/CampaignTemplate/{CampaignTemplateId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CampaignTemplateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CampaignTemplate>
    <CampaignTemplate>
      <CampaignTemplateId>0</CampaignTemplateId>
      <CampaignTypeId>0</CampaignTypeId>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DateDeleted>0001-01-01T00:00:00</DateDeleted>
      <Image>String</Image>
      <Template>String</Template>
      <TemplateName>String</TemplateName>
      <Thumbnail>String</Thumbnail>
    </CampaignTemplate>
  </CampaignTemplate>
  <CampaignTemplateId>0</CampaignTemplateId>
</CampaignTemplateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CampaignTemplateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CampaignTemplate>
    <CampaignTemplate>
      <CampaignTemplateId>0</CampaignTemplateId>
      <CampaignTypeId>0</CampaignTypeId>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DateDeleted>0001-01-01T00:00:00</DateDeleted>
      <Image>String</Image>
      <Template>String</Template>
      <TemplateName>String</TemplateName>
      <Thumbnail>String</Thumbnail>
    </CampaignTemplate>
  </CampaignTemplate>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CampaignTemplateResponse>