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
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class DashboardStatsRequest
{
    open var AgentId:Int? = null
    open var MTDStartDate:String? = null
    open var YTDStartDate:String? = null
    open var EndDate:String? = null
}

open class DashboardItemResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var GeneralMessages:ArrayList<DashboardItem> = ArrayList<DashboardItem>()
    open var PersonCallouts:ArrayList<DashboardItem> = ArrayList<DashboardItem>()
    open var TipOfTheWeek:ArrayList<DashboardItem> = ArrayList<DashboardItem>()
    open var NewsAndNotes:ArrayList<DashboardItem> = ArrayList<DashboardItem>()
}

open class DashboardItem
{
    open var ID:Int? = null
    open var Date:Date? = null
    open var Title:String? = null
    open var Message:String? = null
    open var Author:String? = null
    open var Hyperlink:String? = null
    open var ThumbnailImage:String? = null
    open var StartDate:Date? = null
    open var EndDate:Date? = null
    open var Type:String? = null
    open var SortKey:Int? = null
}

Kotlin DashboardStatsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"GeneralMessages":[{"ID":0,"Date":"0001-01-01T00:00:00.0000000","Title":"String","Message":"String","Author":"String","Hyperlink":"String","ThumbnailImage":"String","StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","Type":"String","SortKey":0}],"PersonCallouts":[{"ID":0,"Date":"0001-01-01T00:00:00.0000000","Title":"String","Message":"String","Author":"String","Hyperlink":"String","ThumbnailImage":"String","StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","Type":"String","SortKey":0}],"TipOfTheWeek":[{"ID":0,"Date":"0001-01-01T00:00:00.0000000","Title":"String","Message":"String","Author":"String","Hyperlink":"String","ThumbnailImage":"String","StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","Type":"String","SortKey":0}],"NewsAndNotes":[{"ID":0,"Date":"0001-01-01T00:00:00.0000000","Title":"String","Message":"String","Author":"String","Hyperlink":"String","ThumbnailImage":"String","StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","Type":"String","SortKey":0}]}