Trendsic Platform Service

ExecutiveDashboardRequest

The following routes are available for this service:
GET,OPTIONS	/v1/dashboards/executive

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 ExecAgingBucket
    {
        public virtual string Bucket { get; set; }
        public virtual double AmountUSD { get; set; }
        public virtual bool IsRetainage { get; set; }
    }

    public partial class ExecBacklog
    {
        public virtual double TotalUSD { get; set; }
        public virtual double MonthsAhead { get; set; }
        public virtual double AwardsYtdUSD { get; set; }
        public virtual double BurnYtdUSD { get; set; }
        public virtual List<ExecBacklogYear> ByYear { get; set; } = [];
    }

    public partial class ExecBacklogYear
    {
        public virtual string Year { get; set; }
        public virtual double ValueUSD { get; set; }
    }

    public partial class ExecCostCategory
    {
        public virtual string Name { get; set; }
        public virtual double CostUSD { get; set; }
        public virtual double BilledUSD { get; set; }
    }

    public partial class ExecKpi
    {
        public virtual string Key { get; set; }
        public virtual string Label { get; set; }
        public virtual string Value { get; set; }
        public virtual string Sub_ { get; set; }
        public virtual string Delta { get; set; }
        public virtual bool DeltaUp { get; set; }
        public virtual bool HasDelta { get; set; }
        public virtual bool Good { get; set; }
    }

    public partial class ExecMonthPoint
    {
        public virtual string Month { get; set; }
        public virtual double RevenueUSD { get; set; }
        public virtual double CostUSD { get; set; }
    }

    public partial class ExecPipelineStage
    {
        public virtual string Stage { get; set; }
        public virtual double ValueUSD { get; set; }
        public virtual int Count { get; set; }
    }

    public partial class ExecSafetyMetric
    {
        public virtual string Label { get; set; }
        public virtual string Value { get; set; }
        public virtual string Sub_ { get; set; }
        public virtual bool Good { get; set; }
    }

    public partial class ExecutiveDashboard
    {
        public virtual string Period { get; set; }
        public virtual DateTime FromDate { get; set; }
        public virtual DateTime ToDate { get; set; }
        public virtual int Fy { get; set; }
        public virtual List<ExecKpi> Kpis { get; set; } = [];
        public virtual List<ExecCostCategory> CostVsBilling { get; set; } = [];
        public virtual List<ExecMonthPoint> Monthly { get; set; } = [];
        public virtual ExecBacklog Backlog { get; set; }
        public virtual List<ExecWipRow> Wip { get; set; } = [];
        public virtual List<ExecPipelineStage> Pipeline { get; set; } = [];
        public virtual double WinRatePct { get; set; }
        public virtual List<ExecAgingBucket> Receivables { get; set; } = [];
        public virtual double RetainageUSD { get; set; }
        public virtual int DsoDays { get; set; }
        public virtual List<ExecSafetyMetric> Safety { get; set; } = [];
    }

    public partial class ExecutiveDashboardRequest
    {
        public virtual string Period { get; set; }
        public virtual string Region { get; set; }
        public virtual int? Fy { get; set; }
    }

    public partial class ExecutiveDashboardResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual ExecutiveDashboard Dashboard { get; set; }
    }

    public partial class ExecWipRow
    {
        public virtual int ContractId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Owner { get; set; }
        public virtual double ValueUSD { get; set; }
        public virtual double PctComplete { get; set; }
        public virtual double BilledUSD { get; set; }
        public virtual double OverUnderUSD { get; set; }
        public virtual double MarginPct { get; set; }
        public virtual double FadePts { get; set; }
    }

}

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

GET /v1/dashboards/executive HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<ExecutiveDashboardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Dashboard>
    <Backlog>
      <AwardsYtdUSD>0</AwardsYtdUSD>
      <BurnYtdUSD>0</BurnYtdUSD>
      <ByYear>
        <ExecBacklogYear>
          <ValueUSD>0</ValueUSD>
          <Year>String</Year>
        </ExecBacklogYear>
      </ByYear>
      <MonthsAhead>0</MonthsAhead>
      <TotalUSD>0</TotalUSD>
    </Backlog>
    <CostVsBilling>
      <ExecCostCategory>
        <BilledUSD>0</BilledUSD>
        <CostUSD>0</CostUSD>
        <Name>String</Name>
      </ExecCostCategory>
    </CostVsBilling>
    <DsoDays>0</DsoDays>
    <FromDate>0001-01-01T00:00:00</FromDate>
    <Fy>0</Fy>
    <Kpis>
      <ExecKpi>
        <Delta>String</Delta>
        <DeltaUp>false</DeltaUp>
        <Good>false</Good>
        <HasDelta>false</HasDelta>
        <Key>String</Key>
        <Label>String</Label>
        <Sub_>String</Sub_>
        <Value>String</Value>
      </ExecKpi>
    </Kpis>
    <Monthly>
      <ExecMonthPoint>
        <CostUSD>0</CostUSD>
        <Month>String</Month>
        <RevenueUSD>0</RevenueUSD>
      </ExecMonthPoint>
    </Monthly>
    <Period>String</Period>
    <Pipeline>
      <ExecPipelineStage>
        <Count>0</Count>
        <Stage>String</Stage>
        <ValueUSD>0</ValueUSD>
      </ExecPipelineStage>
    </Pipeline>
    <Receivables>
      <ExecAgingBucket>
        <AmountUSD>0</AmountUSD>
        <Bucket>String</Bucket>
        <IsRetainage>false</IsRetainage>
      </ExecAgingBucket>
    </Receivables>
    <RetainageUSD>0</RetainageUSD>
    <Safety>
      <ExecSafetyMetric>
        <Good>false</Good>
        <Label>String</Label>
        <Sub_>String</Sub_>
        <Value>String</Value>
      </ExecSafetyMetric>
    </Safety>
    <ToDate>0001-01-01T00:00:00</ToDate>
    <WinRatePct>0</WinRatePct>
    <Wip>
      <ExecWipRow>
        <BilledUSD>0</BilledUSD>
        <ContractId>0</ContractId>
        <FadePts>0</FadePts>
        <MarginPct>0</MarginPct>
        <Name>String</Name>
        <OverUnderUSD>0</OverUnderUSD>
        <Owner>String</Owner>
        <PctComplete>0</PctComplete>
        <ValueUSD>0</ValueUSD>
      </ExecWipRow>
    </Wip>
  </Dashboard>
  <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>
</ExecutiveDashboardResponse>