Trendsic Platform Service

<back to all web services

ProjectDashRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dashboard/project
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class DashboardSeries
    {
        public virtual string Name { get; set; }
        public virtual List<DashboardSeriesPoint> Points { get; set; } = [];
    }

    public partial class DashboardSeriesPoint
    {
        public virtual string Label { get; set; }
        public virtual double Value { get; set; }
    }

    public partial class DashboardStatTile
    {
        public virtual string Key { get; set; }
        public virtual string Label { get; set; }
        public virtual double Value { get; set; }
        public virtual double? PreviousValue { get; set; }
        public virtual string Unit { get; set; }
        public virtual double? DeltaPct { get; set; }
    }

    public partial class ProjectDashOverdueRow
    {
        public virtual string ProjectName { get; set; }
        public virtual string JobName { get; set; }
        public virtual string ExpectedCompletionDate { get; set; }
        public virtual int DaysOverdue { get; set; }
        public virtual bool IsAtRisk { get; set; }
    }

    public partial class ProjectDashRequest
    {
        public virtual DateTime FromDate { get; set; }
        public virtual DateTime ToDate { get; set; }
    }

    public partial class ProjectDashResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<DashboardStatTile> Stats { get; set; } = [];
        public virtual DashboardSeries JobStatus { get; set; }
        public virtual DashboardSeries Throughput { get; set; }
        public virtual DashboardSeries CycleDistribution { get; set; }
        public virtual DashboardSeries Bottleneck { get; set; }
        public virtual List<ProjectDashOverdueRow> OverdueJobs { get; set; } = [];
        public virtual List<ProjectDashRollupRow> Rollup { get; set; } = [];
    }

    public partial class ProjectDashRollupRow
    {
        public virtual string ProjectName { get; set; }
        public virtual string StatusName { get; set; }
        public virtual int JobCount { get; set; }
        public virtual int CompletedJobCount { get; set; }
        public virtual double TaskPct { get; set; }
        public virtual double MilestonePct { get; set; }
    }

}

C# ProjectDashRequest 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.

POST /v1/dashboard/project HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	FromDate: 0001-01-01,
	ToDate: 0001-01-01
}
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
		}
	},
	Stats: 
	[
		{
			Key: String,
			Label: String,
			Value: 0,
			PreviousValue: 0,
			Unit: String
		}
	],
	JobStatus: 
	{
		Name: String,
		Points: 
		[
			{
				Label: String,
				Value: 0
			}
		]
	},
	Throughput: 
	{
		Name: String,
		Points: 
		[
			{
				Label: String,
				Value: 0
			}
		]
	},
	CycleDistribution: 
	{
		Name: String,
		Points: 
		[
			{
				Label: String,
				Value: 0
			}
		]
	},
	Bottleneck: 
	{
		Name: String,
		Points: 
		[
			{
				Label: String,
				Value: 0
			}
		]
	},
	OverdueJobs: 
	[
		{
			ProjectName: String,
			JobName: String,
			ExpectedCompletionDate: String,
			DaysOverdue: 0,
			IsAtRisk: False
		}
	],
	Rollup: 
	[
		{
			ProjectName: String,
			StatusName: String,
			JobCount: 0,
			CompletedJobCount: 0,
			TaskPct: 0,
			MilestonePct: 0
		}
	]
}