Trendsic Platform Service

<back to all web services

DashboardStatsRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/DashboardStats
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type DashboardItem() = 
        member val ID:Int32 = new Int32() with get,set
        member val Date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Title:String = null with get,set
        member val Message:String = null with get,set
        member val Author:String = null with get,set
        member val Hyperlink:String = null with get,set
        member val ThumbnailImage:String = null with get,set
        member val StartDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val EndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Type:String = null with get,set
        member val SortKey:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type DashboardItemResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val GeneralMessages:ResizeArray<DashboardItem> = new ResizeArray<DashboardItem>() with get,set
        member val PersonCallouts:ResizeArray<DashboardItem> = new ResizeArray<DashboardItem>() with get,set
        member val TipOfTheWeek:ResizeArray<DashboardItem> = new ResizeArray<DashboardItem>() with get,set
        member val NewsAndNotes:ResizeArray<DashboardItem> = new ResizeArray<DashboardItem>() with get,set

    [<AllowNullLiteral>]
    type DashboardStatsRequest() = 
        member val AgentId:Int32 = new Int32() with get,set
        member val MTDStartDate:String = null with get,set
        member val YTDStartDate:String = null with get,set
        member val EndDate:String = null with get,set

F# 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>