Trendsic Platform Service

<back to all web services

AddCommissionAdjustmentRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/AddCommissionAdjustment
<?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 AddCommissionAdjustmentResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

class CommAdjustment implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgentId=0,
        /** @var string|null */
        public ?string $AgentName=null,
        /** @var string|null */
        public ?string $PolicyNumber=null,
        /** @var string|null */
        public ?string $InsuredAnnuitant=null,
        /** @var DateTime */
        public DateTime $ProcessDate=new DateTime(),
        /** @var string|null */
        public ?string $Premium=null,
        /** @var float */
        public float $GrossCommission=0.0,
        /** @var string|null */
        public ?string $CommRate=null,
        /** @var string|null */
        public ?string $part=null,
        /** @var float */
        public float $Amount=0.0,
        /** @var DateTime */
        public DateTime $PaymentDate=new DateTime(),
        /** @var string|null */
        public ?string $PolicyType=null,
        /** @var string|null */
        public ?string $Company=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['AgentId'])) $this->AgentId = $o['AgentId'];
        if (isset($o['AgentName'])) $this->AgentName = $o['AgentName'];
        if (isset($o['PolicyNumber'])) $this->PolicyNumber = $o['PolicyNumber'];
        if (isset($o['InsuredAnnuitant'])) $this->InsuredAnnuitant = $o['InsuredAnnuitant'];
        if (isset($o['ProcessDate'])) $this->ProcessDate = JsonConverters::from('DateTime', $o['ProcessDate']);
        if (isset($o['Premium'])) $this->Premium = $o['Premium'];
        if (isset($o['GrossCommission'])) $this->GrossCommission = $o['GrossCommission'];
        if (isset($o['CommRate'])) $this->CommRate = $o['CommRate'];
        if (isset($o['part'])) $this->part = $o['part'];
        if (isset($o['Amount'])) $this->Amount = $o['Amount'];
        if (isset($o['PaymentDate'])) $this->PaymentDate = JsonConverters::from('DateTime', $o['PaymentDate']);
        if (isset($o['PolicyType'])) $this->PolicyType = $o['PolicyType'];
        if (isset($o['Company'])) $this->Company = $o['Company'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->AgentId)) $o['AgentId'] = $this->AgentId;
        if (isset($this->AgentName)) $o['AgentName'] = $this->AgentName;
        if (isset($this->PolicyNumber)) $o['PolicyNumber'] = $this->PolicyNumber;
        if (isset($this->InsuredAnnuitant)) $o['InsuredAnnuitant'] = $this->InsuredAnnuitant;
        if (isset($this->ProcessDate)) $o['ProcessDate'] = JsonConverters::to('DateTime', $this->ProcessDate);
        if (isset($this->Premium)) $o['Premium'] = $this->Premium;
        if (isset($this->GrossCommission)) $o['GrossCommission'] = $this->GrossCommission;
        if (isset($this->CommRate)) $o['CommRate'] = $this->CommRate;
        if (isset($this->part)) $o['part'] = $this->part;
        if (isset($this->Amount)) $o['Amount'] = $this->Amount;
        if (isset($this->PaymentDate)) $o['PaymentDate'] = JsonConverters::to('DateTime', $this->PaymentDate);
        if (isset($this->PolicyType)) $o['PolicyType'] = $this->PolicyType;
        if (isset($this->Company)) $o['Company'] = $this->Company;
        return empty($o) ? new class(){} : $o;
    }
}

class AddCommissionAdjustmentRequest implements JsonSerializable
{
    public function __construct(
        /** @var CommAdjustment|null */
        public ?CommAdjustment $CommAdjustment=null
    ) {
    }

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

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

<AddCommissionAdjustmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CommAdjustment>
    <AgentId>0</AgentId>
    <AgentName>String</AgentName>
    <Amount>0</Amount>
    <CommRate>String</CommRate>
    <Company>String</Company>
    <GrossCommission>0</GrossCommission>
    <InsuredAnnuitant>String</InsuredAnnuitant>
    <PaymentDate>0001-01-01T00:00:00</PaymentDate>
    <PolicyNumber>String</PolicyNumber>
    <PolicyType>String</PolicyType>
    <Premium>String</Premium>
    <ProcessDate>0001-01-01T00:00:00</ProcessDate>
    <part>String</part>
  </CommAdjustment>
</AddCommissionAdjustmentRequest>

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

<AddCommissionAdjustmentResponse 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>
</AddCommissionAdjustmentResponse>