Trendsic Platform Service

<back to all web services

AgentNBCSummaryRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/AgentNBCSummary/{AgentId}
GET,OPTIONS/v1/AgentNBCSummary
<?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 AgentNBCSummary implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $PolicyType=null,
        /** @var int */
        public int $PolicyCount=0,
        /** @var float */
        public float $LifePolicyValue=0.0,
        /** @var float */
        public float $FlowModalPremium=0.0,
        /** @var float */
        public float $FlowAnnualPremium=0.0,
        /** @var float */
        public float $TransferAmount=0.0
    ) {
    }

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

class AgentNBCSummaryResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<AgentNBCSummary>|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('AgentNBCSummary', $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('AgentNBCSummary', $this->result);
        return empty($o) ? new class(){} : $o;
    }
}

class AgentNBCSummaryRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgentId=0
    ) {
    }

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

PHP AgentNBCSummaryRequest 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/AgentNBCSummary/{AgentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<AgentNBCSummaryResponse 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>
    <AgentNBCSummary>
      <FlowAnnualPremium>0</FlowAnnualPremium>
      <FlowModalPremium>0</FlowModalPremium>
      <LifePolicyValue>0</LifePolicyValue>
      <PolicyCount>0</PolicyCount>
      <PolicyType>String</PolicyType>
      <TransferAmount>0</TransferAmount>
    </AgentNBCSummary>
  </result>
</AgentNBCSummaryResponse>