Trendsic Platform Service

<back to all web services

ChatMessageRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET/v1/ChatMessage/{ChatMessageId}
POST,OPTIONS/v1/ChatMessage
<?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 ChatMessage implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $ChatMessageId='',
        /** @var string */
        public string $ChatId='',
        /** @var string */
        public string $SenderUserId='',
        /** @var string|null */
        public ?string $Message=null,
        /** @var string */
        public string $AttachmentId='',
        /** @var DateTime */
        public DateTime $DateCreated=new DateTime(),
        /** @var string|null */
        public ?string $SenderName=null
    ) {
    }

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

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

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

class ChatMessageRequest implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $ChatMessageId='',
        /** @var ChatMessage|null */
        public ?ChatMessage $ChatMessage=null
    ) {
    }

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

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

<ChatMessageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ChatMessage>
    <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
    <ChatId>00000000-0000-0000-0000-000000000000</ChatId>
    <ChatMessageId>00000000-0000-0000-0000-000000000000</ChatMessageId>
    <DateCreated>0001-01-01T00:00:00</DateCreated>
    <Message>String</Message>
    <SenderName>String</SenderName>
    <SenderUserId>00000000-0000-0000-0000-000000000000</SenderUserId>
  </ChatMessage>
  <ChatMessageId>00000000-0000-0000-0000-000000000000</ChatMessageId>
</ChatMessageRequest>

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

<ChatMessageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ChatMessage>
    <ChatMessage>
      <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
      <ChatId>00000000-0000-0000-0000-000000000000</ChatId>
      <ChatMessageId>00000000-0000-0000-0000-000000000000</ChatMessageId>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <Message>String</Message>
      <SenderName>String</SenderName>
      <SenderUserId>00000000-0000-0000-0000-000000000000</SenderUserId>
    </ChatMessage>
  </ChatMessage>
  <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>
</ChatMessageResponse>