Trendsic Platform Service

ConversationByHeaderRequest

The following routes are available for this service:
GET	/v1/ConversationByHeader/{HeaderId}

<?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 ConversationDetail implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $ConversationDetailId='',
        /** @var string */
        public string $ConversationHeaderId='',
        /** @var string|null */
        public ?string $Comment=null,
        /** @var DateTime */
        public DateTime $DateCreated=new DateTime(),
        /** @var string */
        public string $CreatedBy='',
        /** @var string|null */
        public ?string $CreatedByName=null,
        /** @var string */
        public string $AttachmentId='',
        /** @var bool|null */
        public ?bool $IsAdminComment=null,
        /** @var bool|null */
        public ?bool $IsDeletedComment=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ConversationDetailId'])) $this->ConversationDetailId = $o['ConversationDetailId'];
        if (isset($o['ConversationHeaderId'])) $this->ConversationHeaderId = $o['ConversationHeaderId'];
        if (isset($o['Comment'])) $this->Comment = $o['Comment'];
        if (isset($o['DateCreated'])) $this->DateCreated = JsonConverters::from('DateTime', $o['DateCreated']);
        if (isset($o['CreatedBy'])) $this->CreatedBy = $o['CreatedBy'];
        if (isset($o['CreatedByName'])) $this->CreatedByName = $o['CreatedByName'];
        if (isset($o['AttachmentId'])) $this->AttachmentId = $o['AttachmentId'];
        if (isset($o['IsAdminComment'])) $this->IsAdminComment = $o['IsAdminComment'];
        if (isset($o['IsDeletedComment'])) $this->IsDeletedComment = $o['IsDeletedComment'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ConversationDetailId)) $o['ConversationDetailId'] = $this->ConversationDetailId;
        if (isset($this->ConversationHeaderId)) $o['ConversationHeaderId'] = $this->ConversationHeaderId;
        if (isset($this->Comment)) $o['Comment'] = $this->Comment;
        if (isset($this->DateCreated)) $o['DateCreated'] = JsonConverters::to('DateTime', $this->DateCreated);
        if (isset($this->CreatedBy)) $o['CreatedBy'] = $this->CreatedBy;
        if (isset($this->CreatedByName)) $o['CreatedByName'] = $this->CreatedByName;
        if (isset($this->AttachmentId)) $o['AttachmentId'] = $this->AttachmentId;
        if (isset($this->IsAdminComment)) $o['IsAdminComment'] = $this->IsAdminComment;
        if (isset($this->IsDeletedComment)) $o['IsDeletedComment'] = $this->IsDeletedComment;
        return empty($o) ? new class(){} : $o;
    }
}

class Conversation extends ConversationHeader implements JsonSerializable
{
    /**
     * @param string $ConversationHeaderId
     * @param string|null $TableName
     * @param string|null $FieldName
     * @param int $RecordId
     * @param bool|null $AgentHasRead
     * @param bool|null $AdminHasRead
     */
    public function __construct(
        string $ConversationHeaderId='',
        ?string $TableName=null,
        ?string $FieldName=null,
        int $RecordId=0,
        ?bool $AgentHasRead=null,
        ?bool $AdminHasRead=null,
        /** @var array<ConversationDetail>|null */
        public ?array $Details=null
    ) {
        parent::__construct($ConversationHeaderId,$TableName,$FieldName,$RecordId,$AgentHasRead,$AdminHasRead);
    }

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

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

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

class ConversationByHeaderRequest implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $HeaderId=''
    ) {
    }

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

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

GET /v1/ConversationByHeader/{HeaderId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<ConversationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Conversation>
    <AdminHasRead>false</AdminHasRead>
    <AgentHasRead>false</AgentHasRead>
    <ConversationHeaderId>00000000-0000-0000-0000-000000000000</ConversationHeaderId>
    <FieldName>String</FieldName>
    <RecordId>0</RecordId>
    <TableName>String</TableName>
    <Details>
      <ConversationDetail>
        <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
        <Comment>String</Comment>
        <ConversationDetailId>00000000-0000-0000-0000-000000000000</ConversationDetailId>
        <ConversationHeaderId>00000000-0000-0000-0000-000000000000</ConversationHeaderId>
        <CreatedBy>00000000-0000-0000-0000-000000000000</CreatedBy>
        <CreatedByName>String</CreatedByName>
        <DateCreated xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>0001-01-01T00:00:00Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </DateCreated>
        <IsAdminComment>false</IsAdminComment>
        <IsDeletedComment>false</IsDeletedComment>
      </ConversationDetail>
    </Details>
  </Conversation>
  <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>
</ConversationResponse>