Trendsic Platform Service

<back to all web services

DashboardStatsRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/DashboardStats
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class DashboardStatsRequest
    {
        public Integer AgentId = null;
        public String MTDStartDate = null;
        public String YTDStartDate = null;
        public String EndDate = null;
        
        public Integer getAgentId() { return AgentId; }
        public DashboardStatsRequest setAgentId(Integer value) { this.AgentId = value; return this; }
        public String getMtdStartDate() { return MTDStartDate; }
        public DashboardStatsRequest setMtdStartDate(String value) { this.MTDStartDate = value; return this; }
        public String getYtdStartDate() { return YTDStartDate; }
        public DashboardStatsRequest setYtdStartDate(String value) { this.YTDStartDate = value; return this; }
        public String getEndDate() { return EndDate; }
        public DashboardStatsRequest setEndDate(String value) { this.EndDate = value; return this; }
    }

    public static class DashboardItemResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<DashboardItem> GeneralMessages = new ArrayList<DashboardItem>();
        public ArrayList<DashboardItem> PersonCallouts = new ArrayList<DashboardItem>();
        public ArrayList<DashboardItem> TipOfTheWeek = new ArrayList<DashboardItem>();
        public ArrayList<DashboardItem> NewsAndNotes = new ArrayList<DashboardItem>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public DashboardItemResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<DashboardItem> getGeneralMessages() { return GeneralMessages; }
        public DashboardItemResponse setGeneralMessages(ArrayList<DashboardItem> value) { this.GeneralMessages = value; return this; }
        public ArrayList<DashboardItem> getPersonCallouts() { return PersonCallouts; }
        public DashboardItemResponse setPersonCallouts(ArrayList<DashboardItem> value) { this.PersonCallouts = value; return this; }
        public ArrayList<DashboardItem> getTipOfTheWeek() { return TipOfTheWeek; }
        public DashboardItemResponse setTipOfTheWeek(ArrayList<DashboardItem> value) { this.TipOfTheWeek = value; return this; }
        public ArrayList<DashboardItem> getNewsAndNotes() { return NewsAndNotes; }
        public DashboardItemResponse setNewsAndNotes(ArrayList<DashboardItem> value) { this.NewsAndNotes = value; return this; }
    }

    public static class DashboardItem
    {
        public Integer ID = null;
        public Date Date = null;
        public String Title = null;
        public String Message = null;
        public String Author = null;
        public String Hyperlink = null;
        public String ThumbnailImage = null;
        public Date StartDate = null;
        public Date EndDate = null;
        public String Type = null;
        public Integer SortKey = null;
        
        public Integer getId() { return ID; }
        public DashboardItem setId(Integer value) { this.ID = value; return this; }
        public Date getDate() { return Date; }
        public DashboardItem setDate(Date value) { this.Date = value; return this; }
        public String getTitle() { return Title; }
        public DashboardItem setTitle(String value) { this.Title = value; return this; }
        public String getMessage() { return Message; }
        public DashboardItem setMessage(String value) { this.Message = value; return this; }
        public String getAuthor() { return Author; }
        public DashboardItem setAuthor(String value) { this.Author = value; return this; }
        public String getHyperlink() { return Hyperlink; }
        public DashboardItem setHyperlink(String value) { this.Hyperlink = value; return this; }
        public String getThumbnailImage() { return ThumbnailImage; }
        public DashboardItem setThumbnailImage(String value) { this.ThumbnailImage = value; return this; }
        public Date getStartDate() { return StartDate; }
        public DashboardItem setStartDate(Date value) { this.StartDate = value; return this; }
        public Date getEndDate() { return EndDate; }
        public DashboardItem setEndDate(Date value) { this.EndDate = value; return this; }
        public String getType() { return Type; }
        public DashboardItem setType(String value) { this.Type = value; return this; }
        public Integer getSortKey() { return SortKey; }
        public DashboardItem setSortKey(Integer value) { this.SortKey = value; return this; }
    }

}

Java DashboardStatsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>