Trendsic Platform Service

<back to all web services

ListingSummaryRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/ListingSummary/{ID}
GET,POST,PUT,DELETE,OPTIONS/v1/ListingSummary
GET,POST,PUT,DELETE,OPTIONS/v1/ListingSummary/DateRange/{ParamStartDate}/{ParamEndDate}/{AgentID}
GET,POST,PUT,DELETE,OPTIONS/v1/ListingSummary/DateRange/{ParamStartDate}/{ParamEndDate}

export class ListingSummary
{
    public AgentLevel: number;
    public AgentPoints: string;
    public AgentPolicyNumbers: string;
    public AgentYTDTotal: number;
    public AgentRTotal: number;
    public AgentOverallTotal: number;
    public AgentNextLevelPrerequired: number;
    public AgentCurrentYTDTotal: number;
    public AgentCurrentRunningTotal: number;
    public AgentLevelCalculatedFromListingPart: number;
    public AgentRequiredBeforeNextLevel: number;
    public AgentAdjustmentTotal: number;
    public AgentCommissionSubtotal: number;
    public AgentBalanceForward: number;

    public constructor(init?: Partial<ListingSummary>) { (Object as any).assign(this, init); }
}

export class ListingSummaryResponse
{
    public ResponseStatus: ResponseStatus;
    public ListingSummary: ListingSummary[] = [];

    public constructor(init?: Partial<ListingSummaryResponse>) { (Object as any).assign(this, init); }
}

export class ListingSummaryRequest
{
    public ListingSummary: ListingSummary[] = [];
    public AgentID: number;
    public ParamStartDate: string;
    public ParamEndDate: string;

    public constructor(init?: Partial<ListingSummaryRequest>) { (Object as any).assign(this, init); }
}

TypeScript ListingSummaryRequest 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/ListingSummary/{ID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ListingSummaryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgentID>0</AgentID>
  <ListingSummary>
    <ListingSummary>
      <AgentAdjustmentTotal>0</AgentAdjustmentTotal>
      <AgentBalanceForward>0</AgentBalanceForward>
      <AgentCommissionSubtotal>0</AgentCommissionSubtotal>
      <AgentCurrentRunningTotal>0</AgentCurrentRunningTotal>
      <AgentCurrentYTDTotal>0</AgentCurrentYTDTotal>
      <AgentLevel>0</AgentLevel>
      <AgentLevelCalculatedFromListingPart>0</AgentLevelCalculatedFromListingPart>
      <AgentNextLevelPrerequired>0</AgentNextLevelPrerequired>
      <AgentOverallTotal>0</AgentOverallTotal>
      <AgentPoints>String</AgentPoints>
      <AgentPolicyNumbers>String</AgentPolicyNumbers>
      <AgentRTotal>0</AgentRTotal>
      <AgentRequiredBeforeNextLevel>0</AgentRequiredBeforeNextLevel>
      <AgentYTDTotal>0</AgentYTDTotal>
    </ListingSummary>
  </ListingSummary>
  <ParamEndDate>0001-01-01T00:00:00</ParamEndDate>
  <ParamStartDate>0001-01-01T00:00:00</ParamStartDate>
</ListingSummaryRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ListingSummaryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ListingSummary>
    <ListingSummary>
      <AgentAdjustmentTotal>0</AgentAdjustmentTotal>
      <AgentBalanceForward>0</AgentBalanceForward>
      <AgentCommissionSubtotal>0</AgentCommissionSubtotal>
      <AgentCurrentRunningTotal>0</AgentCurrentRunningTotal>
      <AgentCurrentYTDTotal>0</AgentCurrentYTDTotal>
      <AgentLevel>0</AgentLevel>
      <AgentLevelCalculatedFromListingPart>0</AgentLevelCalculatedFromListingPart>
      <AgentNextLevelPrerequired>0</AgentNextLevelPrerequired>
      <AgentOverallTotal>0</AgentOverallTotal>
      <AgentPoints>String</AgentPoints>
      <AgentPolicyNumbers>String</AgentPolicyNumbers>
      <AgentRTotal>0</AgentRTotal>
      <AgentRequiredBeforeNextLevel>0</AgentRequiredBeforeNextLevel>
      <AgentYTDTotal>0</AgentYTDTotal>
    </ListingSummary>
  </ListingSummary>
  <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>
</ListingSummaryResponse>