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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<DashboardAdminRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DashboardItem>
    <Author>String</Author>
    <Date>0001-01-01T00:00:00</Date>
    <EndDate>0001-01-01T00:00:00</EndDate>
    <Hyperlink>String</Hyperlink>
    <ID>0</ID>
    <Message>String</Message>
    <SortKey>0</SortKey>
    <StartDate>0001-01-01T00:00:00</StartDate>
    <ThumbnailImage>String</ThumbnailImage>
    <Title>String</Title>
    <Type>String</Type>
  </DashboardItem>
  <DashboardItemId>String</DashboardItemId>
</DashboardAdminRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DashboardItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Author>String</Author>
  <Date>0001-01-01T00:00:00</Date>
  <EndDate>0001-01-01T00:00:00</EndDate>
  <Hyperlink>String</Hyperlink>
  <ID>0</ID>
  <Message>String</Message>
  <SortKey>0</SortKey>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <ThumbnailImage>String</ThumbnailImage>
  <Title>String</Title>
  <Type>String</Type>
</DashboardItem>