Test

<back to all web services

GetChatHistory

The following routes are available for this service:
All Verbs/chathistory
<?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 int */
        public int $id=0,
        /** @var string|null */
        public ?string $channel=null,
        /** @var string|null */
        public ?string $fromUserId=null,
        /** @var string|null */
        public ?string $fromName=null,
        /** @var string|null */
        public ?string $displayName=null,
        /** @var string|null */
        public ?string $message=null,
        /** @var string|null */
        public ?string $userAuthId=null,
        /** @var bool|null */
        public ?bool $private=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['channel'])) $this->channel = $o['channel'];
        if (isset($o['fromUserId'])) $this->fromUserId = $o['fromUserId'];
        if (isset($o['fromName'])) $this->fromName = $o['fromName'];
        if (isset($o['displayName'])) $this->displayName = $o['displayName'];
        if (isset($o['message'])) $this->message = $o['message'];
        if (isset($o['userAuthId'])) $this->userAuthId = $o['userAuthId'];
        if (isset($o['private'])) $this->private = $o['private'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->channel)) $o['channel'] = $this->channel;
        if (isset($this->fromUserId)) $o['fromUserId'] = $this->fromUserId;
        if (isset($this->fromName)) $o['fromName'] = $this->fromName;
        if (isset($this->displayName)) $o['displayName'] = $this->displayName;
        if (isset($this->message)) $o['message'] = $this->message;
        if (isset($this->userAuthId)) $o['userAuthId'] = $this->userAuthId;
        if (isset($this->private)) $o['private'] = $this->private;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class GetChatHistory implements JsonSerializable
{
    public function __construct(
        /** @var string[]|null */
        public ?array $channels=null,
        /** @var int|null */
        public ?int $afterId=null,
        /** @var int|null */
        public ?int $take=null
    ) {
    }

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

PHP GetChatHistory 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 /chathistory HTTP/1.1 
Host: test.servicestack.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetChatHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Test.ServiceInterface">
  <AfterId>0</AfterId>
  <Channels xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Channels>
  <Take>0</Take>
</GetChatHistory>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetChatHistoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Test.ServiceInterface">
  <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>
  <Results>
    <ChatMessage>
      <Channel>String</Channel>
      <DisplayName>String</DisplayName>
      <FromName>String</FromName>
      <FromUserId>String</FromUserId>
      <Id>0</Id>
      <Message>String</Message>
      <Private>false</Private>
      <UserAuthId>String</UserAuthId>
    </ChatMessage>
  </Results>
</GetChatHistoryResponse>