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
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 DashboardAdminRequest() = 
        member val DashboardItem:DashboardItem = null with get,set
        member val DashboardItemId:String = null with get,set

F# 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
}