| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/DashboardStats |
|---|
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 DashboardItemResponse:
response_status: Optional[ResponseStatus] = None
general_messages: List[DashboardItem] = field(default_factory=list)
person_callouts: List[DashboardItem] = field(default_factory=list)
tip_of_the_week: List[DashboardItem] = field(default_factory=list)
news_and_notes: List[DashboardItem] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DashboardStatsRequest:
agent_id: int = 0
mtd_start_date: Optional[str] = None
ytd_start_date: Optional[str] = None
end_date: Optional[str] = None
Python DashboardStatsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/DashboardStats HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"GeneralMessages":[{"ID":0,"Date":"0001-01-01T00:00:00.0000000","Title":"String","Message":"String","Author":"String","Hyperlink":"String","ThumbnailImage":"String","StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","Type":"String","SortKey":0}],"PersonCallouts":[{"ID":0,"Date":"0001-01-01T00:00:00.0000000","Title":"String","Message":"String","Author":"String","Hyperlink":"String","ThumbnailImage":"String","StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","Type":"String","SortKey":0}],"TipOfTheWeek":[{"ID":0,"Date":"0001-01-01T00:00:00.0000000","Title":"String","Message":"String","Author":"String","Hyperlink":"String","ThumbnailImage":"String","StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","Type":"String","SortKey":0}],"NewsAndNotes":[{"ID":0,"Date":"0001-01-01T00:00:00.0000000","Title":"String","Message":"String","Author":"String","Hyperlink":"String","ThumbnailImage":"String","StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","Type":"String","SortKey":0}]}