Trendsic Platform Service

<back to all web services

ProjectDashRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dashboard/project
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type DashboardStatTile() = 
        member val Key:String = null with get,set
        member val Label:String = null with get,set
        member val Value:Double = new Double() with get,set
        member val PreviousValue:Nullable<Double> = new Nullable<Double>() with get,set
        member val Unit:String = null with get,set
        member val DeltaPct:Nullable<Double> = new Nullable<Double>() with get,set

    [<AllowNullLiteral>]
    type DashboardSeriesPoint() = 
        member val Label:String = null with get,set
        member val Value:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type DashboardSeries() = 
        member val Name:String = null with get,set
        member val Points:ResizeArray<DashboardSeriesPoint> = new ResizeArray<DashboardSeriesPoint>() with get,set

    [<AllowNullLiteral>]
    type ProjectDashOverdueRow() = 
        member val ProjectName:String = null with get,set
        member val JobName:String = null with get,set
        member val ExpectedCompletionDate:String = null with get,set
        member val DaysOverdue:Int32 = new Int32() with get,set
        member val IsAtRisk:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type ProjectDashRollupRow() = 
        member val ProjectName:String = null with get,set
        member val StatusName:String = null with get,set
        member val JobCount:Int32 = new Int32() with get,set
        member val CompletedJobCount:Int32 = new Int32() with get,set
        member val TaskPct:Double = new Double() with get,set
        member val MilestonePct:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type ProjectDashResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Stats:ResizeArray<DashboardStatTile> = new ResizeArray<DashboardStatTile>() with get,set
        member val JobStatus:DashboardSeries = null with get,set
        member val Throughput:DashboardSeries = null with get,set
        member val CycleDistribution:DashboardSeries = null with get,set
        member val Bottleneck:DashboardSeries = null with get,set
        member val OverdueJobs:ResizeArray<ProjectDashOverdueRow> = new ResizeArray<ProjectDashOverdueRow>() with get,set
        member val Rollup:ResizeArray<ProjectDashRollupRow> = new ResizeArray<ProjectDashRollupRow>() with get,set

    [<AllowNullLiteral>]
    type ProjectDashRequest() = 
        member val FromDate:DateTime = new DateTime() with get,set
        member val ToDate:DateTime = new DateTime() with get,set

F# 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
		}
	]
}