Trendsic Platform Service

<back to all web services

DashboardAdminRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/DashboardAdmin/{DashboardItemId}
GET,PUT,POST,DELETE,OPTIONS/v1/DashboardAdmin

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 DashboardAdminRequest
{
    public DashboardItem: DashboardItem;
    public DashboardItemId: string;

    public constructor(init?: Partial<DashboardAdminRequest>) { (Object as any).assign(this, init); }
}

TypeScript DashboardAdminRequest DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/DashboardAdmin HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	DashboardItem: 
	{
		ID: 0,
		Date: 0001-01-01,
		Title: String,
		Message: String,
		Author: String,
		Hyperlink: String,
		ThumbnailImage: String,
		StartDate: 0001-01-01,
		EndDate: 0001-01-01,
		Type: String,
		SortKey: 0
	},
	DashboardItemId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ID: 0,
	Date: 0001-01-01,
	Title: String,
	Message: String,
	Author: String,
	Hyperlink: String,
	ThumbnailImage: String,
	StartDate: 0001-01-01,
	EndDate: 0001-01-01,
	Type: String,
	SortKey: 0
}