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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class DashboardItem
            Public Overridable Property ID As Integer
            Public Overridable Property [Date] As Date?
            Public Overridable Property Title As String
            Public Overridable Property Message As String
            Public Overridable Property Author As String
            Public Overridable Property Hyperlink As String
            Public Overridable Property ThumbnailImage As String
            Public Overridable Property StartDate As Date?
            Public Overridable Property EndDate As Date?
            Public Overridable Property Type As String
            Public Overridable Property SortKey As Integer
        End Class

        Public Partial Class DashboardItemResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property GeneralMessages As List(Of DashboardItem) = New List(Of DashboardItem)
            Public Overridable Property PersonCallouts As List(Of DashboardItem) = New List(Of DashboardItem)
            Public Overridable Property TipOfTheWeek As List(Of DashboardItem) = New List(Of DashboardItem)
            Public Overridable Property NewsAndNotes As List(Of DashboardItem) = New List(Of DashboardItem)
        End Class

        Public Partial Class DashboardStatsRequest
            Public Overridable Property AgentId As Integer
            Public Overridable Property MTDStartDate As String
            Public Overridable Property YTDStartDate As String
            Public Overridable Property EndDate As String
        End Class
    End Namespace
End Namespace

VB.NET 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}]}