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

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class DashboardItem
    {
        public virtual int ID { get; set; }
        public virtual DateTime? Date { get; set; }
        public virtual string Title { get; set; }
        public virtual string Message { get; set; }
        public virtual string Author { get; set; }
        public virtual string Hyperlink { get; set; }
        public virtual string ThumbnailImage { get; set; }
        public virtual DateTime? StartDate { get; set; }
        public virtual DateTime? EndDate { get; set; }
        public virtual string Type { get; set; }
        public virtual int SortKey { get; set; }
    }

    public partial class DashboardItemResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<DashboardItem> GeneralMessages { get; set; } = [];
        public virtual List<DashboardItem> PersonCallouts { get; set; } = [];
        public virtual List<DashboardItem> TipOfTheWeek { get; set; } = [];
        public virtual List<DashboardItem> NewsAndNotes { get; set; } = [];
    }

    public partial class DashboardStatsRequest
    {
        public virtual int AgentId { get; set; }
        public virtual string MTDStartDate { get; set; }
        public virtual string YTDStartDate { get; set; }
        public virtual string EndDate { get; set; }
    }

}

C# DashboardStatsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
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}]}