Trendsic Platform Service

<back to all web services

DashboardItemRequest

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

public class dtos
{

    public static class DashboardItemRequest
    {
        public DashboardItem DashboardItem = null;
        
        public DashboardItem getDashboardItem() { return DashboardItem; }
        public DashboardItemRequest setDashboardItem(DashboardItem value) { this.DashboardItem = 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; }
    }

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

}

Java DashboardItemRequest 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.

GET /v1/DashboardItem HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
			Title: String,
			Message: String,
			Author: String,
			Hyperlink: String,
			ThumbnailImage: String,
			StartDate: 0001-01-01,
			EndDate: 0001-01-01,
			Type: String,
			SortKey: 0
		}
	],
	PersonCallouts: 
	[
		{
			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
		}
	],
	TipOfTheWeek: 
	[
		{
			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
		}
	],
	NewsAndNotes: 
	[
		{
			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
		}
	]
}