Trendsic Platform Service

CampaignTypeRequest

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

The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS	/v1/CampaignType/{CampaignTypeId}
GET,POST,PUT,DELETE,OPTIONS	/v1/CampaignType

<?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 CampaignType implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $CampaignTypeId=0,
        /** @var string|null */
        public ?string $CampaignType=null,
        /** @var string|null */
        public ?string $StoredProcName=null,
        /** @var bool|null */
        public ?bool $Active=null,
        /** @var bool|null */
        public ?bool $UseFrequency=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CampaignTypeId'])) $this->CampaignTypeId = $o['CampaignTypeId'];
        if (isset($o['CampaignType'])) $this->CampaignType = $o['CampaignType'];
        if (isset($o['StoredProcName'])) $this->StoredProcName = $o['StoredProcName'];
        if (isset($o['Active'])) $this->Active = $o['Active'];
        if (isset($o['UseFrequency'])) $this->UseFrequency = $o['UseFrequency'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CampaignTypeId)) $o['CampaignTypeId'] = $this->CampaignTypeId;
        if (isset($this->CampaignType)) $o['CampaignType'] = $this->CampaignType;
        if (isset($this->StoredProcName)) $o['StoredProcName'] = $this->StoredProcName;
        if (isset($this->Active)) $o['Active'] = $this->Active;
        if (isset($this->UseFrequency)) $o['UseFrequency'] = $this->UseFrequency;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

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

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

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

<CampaignTypeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CampaignType>
    <CampaignType>
      <Active>false</Active>
      <CampaignType>String</CampaignType>
      <CampaignTypeId>0</CampaignTypeId>
      <StoredProcName>String</StoredProcName>
      <UseFrequency>false</UseFrequency>
    </CampaignType>
  </CampaignType>
  <CampaignTypeId>0</CampaignTypeId>
</CampaignTypeRequest>

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

<CampaignTypeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CampaignType>
    <CampaignType>
      <Active>false</Active>
      <CampaignType>String</CampaignType>
      <CampaignTypeId>0</CampaignTypeId>
      <StoredProcName>String</StoredProcName>
      <UseFrequency>false</UseFrequency>
    </CampaignType>
  </CampaignType>
  <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>
</CampaignTypeResponse>