Trendsic Platform Service

AgentSupervisorRequest

The following routes are available for this service:
PUT,OPTIONS	/v1/Agent/{AgentId}/Supervisor

<?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 AgentSupervisorResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var int */
        public int $AgentId=0,
        /** @var int|null */
        public ?int $SupervisorAgentId=null,
        /** @var string|null */
        public ?string $SupervisorName=null,
        /** @var bool|null */
        public ?bool $CanApprove=null
    ) {
    }

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

class AgentSupervisorRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgentId=0,
        /** @var int|null */
        public ?int $SupervisorAgentId=null
    ) {
    }

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

PHP AgentSupervisorRequest 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/Agent/{AgentId}/Supervisor HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AgentSupervisorRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgentId>0</AgentId>
  <SupervisorAgentId>0</SupervisorAgentId>
</AgentSupervisorRequest>

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

<AgentSupervisorResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgentId>0</AgentId>
  <CanApprove>false</CanApprove>
  <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>
  <SupervisorAgentId>0</SupervisorAgentId>
  <SupervisorName>String</SupervisorName>
</AgentSupervisorResponse>