Trendsic Platform Service

<back to all web services

ChatMemberRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator
The following routes are available for this service:
DELETE,OPTIONS/v1/ChatMember/{ChatMemberId}
PUT,OPTIONS/v1/ChatMember/{ChatMemberId}/Archive
<?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 ChatMember implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $ChatMemberId='',
        /** @var string */
        public string $ChatId='',
        /** @var string */
        public string $UserId='',
        /** @var bool|null */
        public ?bool $IsActive=null,
        /** @var bool|null */
        public ?bool $IsArchived=null,
        /** @var string */
        public string $LastChatMessageId='',
        /** @var string|null */
        public ?string $ChatMemberName=null
    ) {
    }

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

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

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

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

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

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

PUT /v1/ChatMember/{ChatMemberId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ChatMemberRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ChatMemberId>00000000-0000-0000-0000-000000000000</ChatMemberId>
</ChatMemberRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ChatMemberResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ChatMember>
    <ChatMember>
      <ChatId>00000000-0000-0000-0000-000000000000</ChatId>
      <ChatMemberId>00000000-0000-0000-0000-000000000000</ChatMemberId>
      <ChatMemberName>String</ChatMemberName>
      <IsActive>false</IsActive>
      <IsArchived>false</IsArchived>
      <LastChatMessageId>00000000-0000-0000-0000-000000000000</LastChatMessageId>
      <UserId>00000000-0000-0000-0000-000000000000</UserId>
    </ChatMember>
  </ChatMember>
  <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>
</ChatMemberResponse>