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 Foundation
import ServiceStack

public class DashboardItemRequest : Codable
{
    public var dashboardItem:DashboardItem

    required public init(){}
}

public class DashboardItem : Codable
{
    public var id:Int
    public var date:Date?
    public var title:String
    public var message:String
    public var author:String
    public var hyperlink:String
    public var thumbnailImage:String
    public var startDate:Date?
    public var endDate:Date?
    public var type:String
    public var sortKey:Int

    required public init(){}
}

public class DashboardItemResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var generalMessages:[DashboardItem] = []
    public var personCallouts:[DashboardItem] = []
    public var tipOfTheWeek:[DashboardItem] = []
    public var newsAndNotes:[DashboardItem] = []

    required public init(){}
}


Swift 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
		}
	]
}