| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/DashboardStats |
|---|
export class DashboardItem
{
public ID: number;
public Date?: string;
public Title: string;
public Message: string;
public Author: string;
public Hyperlink: string;
public ThumbnailImage: string;
public StartDate?: string;
public EndDate?: string;
public Type: string;
public SortKey: number;
public constructor(init?: Partial<DashboardItem>) { (Object as any).assign(this, init); }
}
export class DashboardItemResponse
{
public ResponseStatus: ResponseStatus;
public GeneralMessages: DashboardItem[] = [];
public PersonCallouts: DashboardItem[] = [];
public TipOfTheWeek: DashboardItem[] = [];
public NewsAndNotes: DashboardItem[] = [];
public constructor(init?: Partial<DashboardItemResponse>) { (Object as any).assign(this, init); }
}
export class DashboardStatsRequest
{
public AgentId: number;
public MTDStartDate: string;
public YTDStartDate: string;
public EndDate: string;
public constructor(init?: Partial<DashboardStatsRequest>) { (Object as any).assign(this, init); }
}
TypeScript DashboardStatsRequest DTOs
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}]}