Trendsic Platform Service

AgentHistoryRequest

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

The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS	/v1/AgentHistory

<?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 AgentHistory implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgentHistoryId=0,
        /** @var int */
        public int $SubAgentId=0,
        /** @var int */
        public int $EventId=0,
        /** @var int */
        public int $AgentId=0,
        /** @var DateTime */
        public DateTime $EventDate=new DateTime(),
        /** @var DateTime */
        public DateTime $DateCreated=new DateTime(),
        /** @var string|null */
        public ?string $Note=null
    ) {
    }

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

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

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

class AgentHistoryRequest implements JsonSerializable
{
    public function __construct(
        /** @var array<AgentHistory>|null */
        public ?array $AgentHistory=null
    ) {
    }

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

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

<AgentHistoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgentHistory>
    <AgentHistory>
      <AgentHistoryId>0</AgentHistoryId>
      <AgentId>0</AgentId>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <EventDate>0001-01-01T00:00:00</EventDate>
      <EventId>0</EventId>
      <Note>String</Note>
      <SubAgentId>0</SubAgentId>
    </AgentHistory>
  </AgentHistory>
</AgentHistoryRequest>

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

<AgentHistoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgentHistory>
    <AgentHistory>
      <AgentHistoryId>0</AgentHistoryId>
      <AgentId>0</AgentId>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <EventDate>0001-01-01T00:00:00</EventDate>
      <EventId>0</EventId>
      <Note>String</Note>
      <SubAgentId>0</SubAgentId>
    </AgentHistory>
  </AgentHistory>
  <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>
</AgentHistoryResponse>