| Requires any of the roles: | Agent, Administrator |
| 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
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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}]}