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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DashboardItem:
    id: int = 0
    date: Optional[datetime.datetime] = None
    title: Optional[str] = None
    message: Optional[str] = None
    author: Optional[str] = None
    hyperlink: Optional[str] = None
    thumbnail_image: Optional[str] = None
    start_date: Optional[datetime.datetime] = None
    end_date: Optional[datetime.datetime] = None
    type: Optional[str] = None
    sort_key: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DashboardAdminRequest:
    dashboard_item: Optional[DashboardItem] = None
    dashboard_item_id: Optional[str] = None

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