Trendsic Platform Service

<back to all web services

AgentCRMCommissionSummaryRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/AgentCRMCommissionSummary
GET,OPTIONS/v1/AgentCRMCommissionSummary/{AgentId}/{StartDate}
<?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 AgentCRMCommissionSummary implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $PolicyType=null,
        /** @var float */
        public float $TotalLifeTime=0.0,
        /** @var float */
        public float $Total365=0.0,
        /** @var float */
        public float $TotalYtd=0.0,
        /** @var float */
        public float $TotalMtd=0.0,
        /** @var float */
        public float $Pending=0.0
    ) {
    }

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

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

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

class AgentCRMCommissionSummaryRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgentId=0,
        /** @var DateTime */
        public DateTime $StartDate=new DateTime()
    ) {
    }

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

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

GET /v1/AgentCRMCommissionSummary HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgentCRMCommissionSummaryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <result>
    <AgentCRMCommissionSummary>
      <Pending>0</Pending>
      <PolicyType>String</PolicyType>
      <Total365>0</Total365>
      <TotalLifeTime>0</TotalLifeTime>
      <TotalMtd>0</TotalMtd>
      <TotalYtd>0</TotalYtd>
    </AgentCRMCommissionSummary>
  </result>
</AgentCRMCommissionSummaryResponse>