Trendsic Platform Service

DashboardStatsRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
GET,OPTIONS	/v1/DashboardStats

"use strict";
export class DashboardItem {
    /** @param {{ID?:number,Date?:string,Title?:string,Message?:string,Author?:string,Hyperlink?:string,ThumbnailImage?:string,StartDate?:string,EndDate?:string,Type?:string,SortKey?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {?string} */
    Date;
    /** @type {string} */
    Title;
    /** @type {string} */
    Message;
    /** @type {string} */
    Author;
    /** @type {string} */
    Hyperlink;
    /** @type {string} */
    ThumbnailImage;
    /** @type {?string} */
    StartDate;
    /** @type {?string} */
    EndDate;
    /** @type {string} */
    Type;
    /** @type {number} */
    SortKey;
}
export class DashboardItemResponse {
    /** @param {{ResponseStatus?:ResponseStatus,GeneralMessages?:DashboardItem[],PersonCallouts?:DashboardItem[],TipOfTheWeek?:DashboardItem[],NewsAndNotes?:DashboardItem[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {DashboardItem[]} */
    GeneralMessages = [];
    /** @type {DashboardItem[]} */
    PersonCallouts = [];
    /** @type {DashboardItem[]} */
    TipOfTheWeek = [];
    /** @type {DashboardItem[]} */
    NewsAndNotes = [];
}
export class DashboardStatsRequest {
    /** @param {{AgentId?:number,MTDStartDate?:string,YTDStartDate?:string,EndDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentId;
    /** @type {string} */
    MTDStartDate;
    /** @type {string} */
    YTDStartDate;
    /** @type {string} */
    EndDate;
}

JavaScript DashboardStatsRequest 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/DashboardStats HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<DashboardItemResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <GeneralMessages>
    <DashboardItem>
      <Author>String</Author>
      <Date>0001-01-01T00:00:00</Date>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <Hyperlink>String</Hyperlink>
      <ID>0</ID>
      <Message>String</Message>
      <SortKey>0</SortKey>
      <StartDate>0001-01-01T00:00:00</StartDate>
      <ThumbnailImage>String</ThumbnailImage>
      <Title>String</Title>
      <Type>String</Type>
    </DashboardItem>
  </GeneralMessages>
  <NewsAndNotes>
    <DashboardItem>
      <Author>String</Author>
      <Date>0001-01-01T00:00:00</Date>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <Hyperlink>String</Hyperlink>
      <ID>0</ID>
      <Message>String</Message>
      <SortKey>0</SortKey>
      <StartDate>0001-01-01T00:00:00</StartDate>
      <ThumbnailImage>String</ThumbnailImage>
      <Title>String</Title>
      <Type>String</Type>
    </DashboardItem>
  </NewsAndNotes>
  <PersonCallouts>
    <DashboardItem>
      <Author>String</Author>
      <Date>0001-01-01T00:00:00</Date>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <Hyperlink>String</Hyperlink>
      <ID>0</ID>
      <Message>String</Message>
      <SortKey>0</SortKey>
      <StartDate>0001-01-01T00:00:00</StartDate>
      <ThumbnailImage>String</ThumbnailImage>
      <Title>String</Title>
      <Type>String</Type>
    </DashboardItem>
  </PersonCallouts>
  <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>
  <TipOfTheWeek>
    <DashboardItem>
      <Author>String</Author>
      <Date>0001-01-01T00:00:00</Date>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <Hyperlink>String</Hyperlink>
      <ID>0</ID>
      <Message>String</Message>
      <SortKey>0</SortKey>
      <StartDate>0001-01-01T00:00:00</StartDate>
      <ThumbnailImage>String</ThumbnailImage>
      <Title>String</Title>
      <Type>String</Type>
    </DashboardItem>
  </TipOfTheWeek>
</DashboardItemResponse>