| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/DashboardStats |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
open class DashboardStatsRequest
{
open var AgentId:Int? = null
open var MTDStartDate:String? = null
open var YTDStartDate:String? = null
open var EndDate:String? = null
}
open class DashboardItemResponse
{
open var ResponseStatus:ResponseStatus? = null
open var GeneralMessages:ArrayList<DashboardItem> = ArrayList<DashboardItem>()
open var PersonCallouts:ArrayList<DashboardItem> = ArrayList<DashboardItem>()
open var TipOfTheWeek:ArrayList<DashboardItem> = ArrayList<DashboardItem>()
open var NewsAndNotes:ArrayList<DashboardItem> = ArrayList<DashboardItem>()
}
open class DashboardItem
{
open var ID:Int? = null
open var Date:Date? = null
open var Title:String? = null
open var Message:String? = null
open var Author:String? = null
open var Hyperlink:String? = null
open var ThumbnailImage:String? = null
open var StartDate:Date? = null
open var EndDate:Date? = null
open var Type:String? = null
open var SortKey:Int? = null
}
Kotlin DashboardStatsRequest 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.
GET /v1/DashboardStats HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<DashboardItemResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<GeneralMessages>
<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>
</GeneralMessages>
<NewsAndNotes>
<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>
</NewsAndNotes>
<PersonCallouts>
<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>
</PersonCallouts>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<TipOfTheWeek>
<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>
</TipOfTheWeek>
</DashboardItemResponse>