| Requires any of the roles: | Agent, Administrator |
| 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 .xml suffix or ?format=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>