Trendsic Platform Service

<back to all web services

ActivityDataRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/ActivityData/{AgentId}/{DateFrom}/{DateTo}
"use strict";
export class ActivityPlan {
    /** @param {{Id?:number,AgentId?:number,EventTypeId?:number,Goal?:number,DateFrom?:string,DateTo?:string,DateCreated?:string,MthlyCashFlow?:number,YTDCashFlow?:number,Recruit?:number,EventTypeName?:string,Actual?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    AgentId;
    /** @type {number} */
    EventTypeId;
    /** @type {number} */
    Goal;
    /** @type {string} */
    DateFrom;
    /** @type {string} */
    DateTo;
    /** @type {string} */
    DateCreated;
    /** @type {number} */
    MthlyCashFlow;
    /** @type {number} */
    YTDCashFlow;
    /** @type {number} */
    Recruit;
    /** @type {string} */
    EventTypeName;
    /** @type {number} */
    Actual;
}
export class ActivityPlanExtended {
    /** @param {{AppCount?:number,AvgFlow?:number,AvgTransfer?:number,AvgLife?:number,LifePerAnnuity?:number,FlowTransfer?:number,TransferRatio?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AppCount;
    /** @type {number} */
    AvgFlow;
    /** @type {number} */
    AvgTransfer;
    /** @type {number} */
    AvgLife;
    /** @type {number} */
    LifePerAnnuity;
    /** @type {number} */
    FlowTransfer;
    /** @type {number} */
    TransferRatio;
}
export class ActivityPlanResponse {
    /** @param {{ResponseStatus?:ResponseStatus,ActivityPlans?:ActivityPlan[],ActivityData?:ActivityPlanExtended}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {ActivityPlan[]} */
    ActivityPlans = [];
    /** @type {ActivityPlanExtended} */
    ActivityData;
}
export class ActivityDataRequest {
    /** @param {{AgentId?:number,DateFrom?:string,DateTo?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentId;
    /** @type {string} */
    DateFrom;
    /** @type {string} */
    DateTo;
}

JavaScript ActivityDataRequest 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/ActivityData/{AgentId}/{DateFrom}/{DateTo} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ActivityPlanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ActivityData>
    <AppCount>0</AppCount>
    <AvgFlow>0</AvgFlow>
    <AvgLife>0</AvgLife>
    <AvgTransfer>0</AvgTransfer>
    <FlowTransfer>0</FlowTransfer>
    <LifePerAnnuity>0</LifePerAnnuity>
    <TransferRatio>0</TransferRatio>
  </ActivityData>
  <ActivityPlans>
    <ActivityPlan>
      <Actual>0</Actual>
      <AgentId>0</AgentId>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DateFrom>0001-01-01T00:00:00</DateFrom>
      <DateTo>0001-01-01T00:00:00</DateTo>
      <EventTypeId>0</EventTypeId>
      <EventTypeName>String</EventTypeName>
      <Goal>0</Goal>
      <Id>0</Id>
      <MthlyCashFlow>0</MthlyCashFlow>
      <Recruit>0</Recruit>
      <YTDCashFlow>0</YTDCashFlow>
    </ActivityPlan>
  </ActivityPlans>
  <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>
</ActivityPlanResponse>