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

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

<ProjectDashRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FromDate>0001-01-01T00:00:00</FromDate>
  <ToDate>0001-01-01T00:00:00</ToDate>
</ProjectDashRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProjectDashResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Bottleneck>
    <Name>String</Name>
    <Points>
      <DashboardSeriesPoint>
        <Label>String</Label>
        <Value>0</Value>
      </DashboardSeriesPoint>
    </Points>
  </Bottleneck>
  <CycleDistribution>
    <Name>String</Name>
    <Points>
      <DashboardSeriesPoint>
        <Label>String</Label>
        <Value>0</Value>
      </DashboardSeriesPoint>
    </Points>
  </CycleDistribution>
  <JobStatus>
    <Name>String</Name>
    <Points>
      <DashboardSeriesPoint>
        <Label>String</Label>
        <Value>0</Value>
      </DashboardSeriesPoint>
    </Points>
  </JobStatus>
  <OverdueJobs>
    <ProjectDashOverdueRow>
      <DaysOverdue>0</DaysOverdue>
      <ExpectedCompletionDate>String</ExpectedCompletionDate>
      <IsAtRisk>false</IsAtRisk>
      <JobName>String</JobName>
      <ProjectName>String</ProjectName>
    </ProjectDashOverdueRow>
  </OverdueJobs>
  <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>
  <Rollup>
    <ProjectDashRollupRow>
      <CompletedJobCount>0</CompletedJobCount>
      <JobCount>0</JobCount>
      <MilestonePct>0</MilestonePct>
      <ProjectName>String</ProjectName>
      <StatusName>String</StatusName>
      <TaskPct>0</TaskPct>
    </ProjectDashRollupRow>
  </Rollup>
  <Stats>
    <DashboardStatTile>
      <Key>String</Key>
      <Label>String</Label>
      <PreviousValue>0</PreviousValue>
      <Unit>String</Unit>
      <Value>0</Value>
    </DashboardStatTile>
  </Stats>
  <Throughput>
    <Name>String</Name>
    <Points>
      <DashboardSeriesPoint>
        <Label>String</Label>
        <Value>0</Value>
      </DashboardSeriesPoint>
    </Points>
  </Throughput>
</ProjectDashResponse>