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
"use strict";
export class AgentNBCSummary {
    /** @param {{PolicyType?:string,PolicyCount?:number,LifePolicyValue?:number,FlowModalPremium?:number,FlowAnnualPremium?:number,TransferAmount?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    PolicyType;
    /** @type {number} */
    PolicyCount;
    /** @type {number} */
    LifePolicyValue;
    /** @type {number} */
    FlowModalPremium;
    /** @type {number} */
    FlowAnnualPremium;
    /** @type {number} */
    TransferAmount;
}
export class AgentNBCSummaryResponse {
    /** @param {{ResponseStatus?:ResponseStatus,result?:AgentNBCSummary[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {AgentNBCSummary[]} */
    result = [];
}
export class AgentNBCSummaryRequest {
    /** @param {{AgentId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentId;
}

JavaScript 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>