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
"use strict";
export class DashboardItem {
    /** @param {{ID?:number,Date?:string,Title?:string,Message?:string,Author?:string,Hyperlink?:string,ThumbnailImage?:string,StartDate?:string,EndDate?:string,Type?:string,SortKey?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {?string} */
    Date;
    /** @type {string} */
    Title;
    /** @type {string} */
    Message;
    /** @type {string} */
    Author;
    /** @type {string} */
    Hyperlink;
    /** @type {string} */
    ThumbnailImage;
    /** @type {?string} */
    StartDate;
    /** @type {?string} */
    EndDate;
    /** @type {string} */
    Type;
    /** @type {number} */
    SortKey;
}
export class DashboardAdminRequest {
    /** @param {{DashboardItem?:DashboardItem,DashboardItemId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {DashboardItem} */
    DashboardItem;
    /** @type {string} */
    DashboardItemId;
}

JavaScript 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
}