Trendsic Platform Service

ConversationHeaderRequest

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

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

<?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 ConversationHeader implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $ConversationHeaderId='',
        /** @var string|null */
        public ?string $TableName=null,
        /** @var string|null */
        public ?string $FieldName=null,
        /** @var int */
        public int $RecordId=0,
        /** @var bool|null */
        public ?bool $AgentHasRead=null,
        /** @var bool|null */
        public ?bool $AdminHasRead=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ConversationHeaderId'])) $this->ConversationHeaderId = $o['ConversationHeaderId'];
        if (isset($o['TableName'])) $this->TableName = $o['TableName'];
        if (isset($o['FieldName'])) $this->FieldName = $o['FieldName'];
        if (isset($o['RecordId'])) $this->RecordId = $o['RecordId'];
        if (isset($o['AgentHasRead'])) $this->AgentHasRead = $o['AgentHasRead'];
        if (isset($o['AdminHasRead'])) $this->AdminHasRead = $o['AdminHasRead'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ConversationHeaderId)) $o['ConversationHeaderId'] = $this->ConversationHeaderId;
        if (isset($this->TableName)) $o['TableName'] = $this->TableName;
        if (isset($this->FieldName)) $o['FieldName'] = $this->FieldName;
        if (isset($this->RecordId)) $o['RecordId'] = $this->RecordId;
        if (isset($this->AgentHasRead)) $o['AgentHasRead'] = $this->AgentHasRead;
        if (isset($this->AdminHasRead)) $o['AdminHasRead'] = $this->AdminHasRead;
        return empty($o) ? new class(){} : $o;
    }
}

class ConversationHeaderResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var ConversationHeader|null */
        public ?ConversationHeader $ConversationHeader=null
    ) {
    }

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

class ConversationHeaderRequest implements JsonSerializable
{
    public function __construct(
        /** @var ConversationHeader|null */
        public ?ConversationHeader $ConversationHeader=null
    ) {
    }

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

PHP ConversationHeaderRequest 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/ConversationHeader HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ConversationHeaderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ConversationHeader>
    <AdminHasRead>false</AdminHasRead>
    <AgentHasRead>false</AgentHasRead>
    <ConversationHeaderId>00000000-0000-0000-0000-000000000000</ConversationHeaderId>
    <FieldName>String</FieldName>
    <RecordId>0</RecordId>
    <TableName>String</TableName>
  </ConversationHeader>
</ConversationHeaderRequest>

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

<ConversationHeaderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ConversationHeader>
    <AdminHasRead>false</AdminHasRead>
    <AgentHasRead>false</AgentHasRead>
    <ConversationHeaderId>00000000-0000-0000-0000-000000000000</ConversationHeaderId>
    <FieldName>String</FieldName>
    <RecordId>0</RecordId>
    <TableName>String</TableName>
  </ConversationHeader>
  <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>
</ConversationHeaderResponse>