Trendsic Platform Service

<back to all web services

ExecutiveDashboardRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/dashboards/executive
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class ExecutiveDashboardRequest
    {
        public String Period = null;
        public String Region = null;
        public Integer Fy = null;
        
        public String getPeriod() { return Period; }
        public ExecutiveDashboardRequest setPeriod(String value) { this.Period = value; return this; }
        public String getRegion() { return Region; }
        public ExecutiveDashboardRequest setRegion(String value) { this.Region = value; return this; }
        public Integer getFy() { return Fy; }
        public ExecutiveDashboardRequest setFy(Integer value) { this.Fy = value; return this; }
    }

    public static class ExecutiveDashboardResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ExecutiveDashboard Dashboard = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ExecutiveDashboardResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ExecutiveDashboard getDashboard() { return Dashboard; }
        public ExecutiveDashboardResponse setDashboard(ExecutiveDashboard value) { this.Dashboard = value; return this; }
    }

    public static class ExecutiveDashboard
    {
        public String Period = null;
        public Date FromDate = null;
        public Date ToDate = null;
        public Integer Fy = null;
        public ArrayList<ExecKpi> Kpis = new ArrayList<ExecKpi>();
        public ArrayList<ExecCostCategory> CostVsBilling = new ArrayList<ExecCostCategory>();
        public ArrayList<ExecMonthPoint> Monthly = new ArrayList<ExecMonthPoint>();
        public ExecBacklog Backlog = null;
        public ArrayList<ExecWipRow> Wip = new ArrayList<ExecWipRow>();
        public Integer WipTotalCount = null;
        public String BuildDiag = null;
        public ArrayList<ExecPipelineStage> Pipeline = new ArrayList<ExecPipelineStage>();
        public Double WinRatePct = null;
        public ArrayList<ExecAgingBucket> Receivables = new ArrayList<ExecAgingBucket>();
        public Double RetainageUSD = null;
        public Integer DsoDays = null;
        public ArrayList<ExecSafetyMetric> Safety = new ArrayList<ExecSafetyMetric>();
        
        public String getPeriod() { return Period; }
        public ExecutiveDashboard setPeriod(String value) { this.Period = value; return this; }
        public Date getFromDate() { return FromDate; }
        public ExecutiveDashboard setFromDate(Date value) { this.FromDate = value; return this; }
        public Date getToDate() { return ToDate; }
        public ExecutiveDashboard setToDate(Date value) { this.ToDate = value; return this; }
        public Integer getFy() { return Fy; }
        public ExecutiveDashboard setFy(Integer value) { this.Fy = value; return this; }
        public ArrayList<ExecKpi> getKpis() { return Kpis; }
        public ExecutiveDashboard setKpis(ArrayList<ExecKpi> value) { this.Kpis = value; return this; }
        public ArrayList<ExecCostCategory> getCostVsBilling() { return CostVsBilling; }
        public ExecutiveDashboard setCostVsBilling(ArrayList<ExecCostCategory> value) { this.CostVsBilling = value; return this; }
        public ArrayList<ExecMonthPoint> getMonthly() { return Monthly; }
        public ExecutiveDashboard setMonthly(ArrayList<ExecMonthPoint> value) { this.Monthly = value; return this; }
        public ExecBacklog getBacklog() { return Backlog; }
        public ExecutiveDashboard setBacklog(ExecBacklog value) { this.Backlog = value; return this; }
        public ArrayList<ExecWipRow> getWip() { return Wip; }
        public ExecutiveDashboard setWip(ArrayList<ExecWipRow> value) { this.Wip = value; return this; }
        public Integer getWipTotalCount() { return WipTotalCount; }
        public ExecutiveDashboard setWipTotalCount(Integer value) { this.WipTotalCount = value; return this; }
        public String getBuildDiag() { return BuildDiag; }
        public ExecutiveDashboard setBuildDiag(String value) { this.BuildDiag = value; return this; }
        public ArrayList<ExecPipelineStage> getPipeline() { return Pipeline; }
        public ExecutiveDashboard setPipeline(ArrayList<ExecPipelineStage> value) { this.Pipeline = value; return this; }
        public Double getWinRatePct() { return WinRatePct; }
        public ExecutiveDashboard setWinRatePct(Double value) { this.WinRatePct = value; return this; }
        public ArrayList<ExecAgingBucket> getReceivables() { return Receivables; }
        public ExecutiveDashboard setReceivables(ArrayList<ExecAgingBucket> value) { this.Receivables = value; return this; }
        public Double getRetainageUSD() { return RetainageUSD; }
        public ExecutiveDashboard setRetainageUSD(Double value) { this.RetainageUSD = value; return this; }
        public Integer getDsoDays() { return DsoDays; }
        public ExecutiveDashboard setDsoDays(Integer value) { this.DsoDays = value; return this; }
        public ArrayList<ExecSafetyMetric> getSafety() { return Safety; }
        public ExecutiveDashboard setSafety(ArrayList<ExecSafetyMetric> value) { this.Safety = value; return this; }
    }

    public static class ExecKpi
    {
        public String Key = null;
        public String Label = null;
        public String Value = null;
        public String Sub_ = null;
        public String Delta = null;
        public Boolean DeltaUp = null;
        public Boolean HasDelta = null;
        public Boolean Good = null;
        
        public String getKey() { return Key; }
        public ExecKpi setKey(String value) { this.Key = value; return this; }
        public String getLabel() { return Label; }
        public ExecKpi setLabel(String value) { this.Label = value; return this; }
        public String getValue() { return Value; }
        public ExecKpi setValue(String value) { this.Value = value; return this; }
        public String getSub() { return Sub_; }
        public ExecKpi setSub(String value) { this.Sub_ = value; return this; }
        public String getDelta() { return Delta; }
        public ExecKpi setDelta(String value) { this.Delta = value; return this; }
        public Boolean isDeltaUp() { return DeltaUp; }
        public ExecKpi setDeltaUp(Boolean value) { this.DeltaUp = value; return this; }
        public Boolean isHasDelta() { return HasDelta; }
        public ExecKpi setHasDelta(Boolean value) { this.HasDelta = value; return this; }
        public Boolean isGood() { return Good; }
        public ExecKpi setGood(Boolean value) { this.Good = value; return this; }
    }

    public static class ExecCostCategory
    {
        public String Name = null;
        public Double CostUSD = null;
        public Double BilledUSD = null;
        
        public String getName() { return Name; }
        public ExecCostCategory setName(String value) { this.Name = value; return this; }
        public Double getCostUSD() { return CostUSD; }
        public ExecCostCategory setCostUSD(Double value) { this.CostUSD = value; return this; }
        public Double getBilledUSD() { return BilledUSD; }
        public ExecCostCategory setBilledUSD(Double value) { this.BilledUSD = value; return this; }
    }

    public static class ExecMonthPoint
    {
        public String Month = null;
        public Double RevenueUSD = null;
        public Double CostUSD = null;
        
        public String getMonth() { return Month; }
        public ExecMonthPoint setMonth(String value) { this.Month = value; return this; }
        public Double getRevenueUSD() { return RevenueUSD; }
        public ExecMonthPoint setRevenueUSD(Double value) { this.RevenueUSD = value; return this; }
        public Double getCostUSD() { return CostUSD; }
        public ExecMonthPoint setCostUSD(Double value) { this.CostUSD = value; return this; }
    }

    public static class ExecBacklog
    {
        public Double TotalUSD = null;
        public Double MonthsAhead = null;
        public Double AwardsYtdUSD = null;
        public Double BurnYtdUSD = null;
        public ArrayList<ExecBacklogYear> ByYear = new ArrayList<ExecBacklogYear>();
        
        public Double getTotalUSD() { return TotalUSD; }
        public ExecBacklog setTotalUSD(Double value) { this.TotalUSD = value; return this; }
        public Double getMonthsAhead() { return MonthsAhead; }
        public ExecBacklog setMonthsAhead(Double value) { this.MonthsAhead = value; return this; }
        public Double getAwardsYtdUSD() { return AwardsYtdUSD; }
        public ExecBacklog setAwardsYtdUSD(Double value) { this.AwardsYtdUSD = value; return this; }
        public Double getBurnYtdUSD() { return BurnYtdUSD; }
        public ExecBacklog setBurnYtdUSD(Double value) { this.BurnYtdUSD = value; return this; }
        public ArrayList<ExecBacklogYear> getByYear() { return ByYear; }
        public ExecBacklog setByYear(ArrayList<ExecBacklogYear> value) { this.ByYear = value; return this; }
    }

    public static class ExecBacklogYear
    {
        public String Year = null;
        public Double ValueUSD = null;
        
        public String getYear() { return Year; }
        public ExecBacklogYear setYear(String value) { this.Year = value; return this; }
        public Double getValueUSD() { return ValueUSD; }
        public ExecBacklogYear setValueUSD(Double value) { this.ValueUSD = value; return this; }
    }

    public static class ExecWipRow
    {
        public Integer ContractId = null;
        public String Name = null;
        public String Owner = null;
        public Double ValueUSD = null;
        public Double PctComplete = null;
        public Double BilledUSD = null;
        public Double OverUnderUSD = null;
        public Double MarginPct = null;
        public Double FadePts = null;
        
        public Integer getContractId() { return ContractId; }
        public ExecWipRow setContractId(Integer value) { this.ContractId = value; return this; }
        public String getName() { return Name; }
        public ExecWipRow setName(String value) { this.Name = value; return this; }
        public String getOwner() { return Owner; }
        public ExecWipRow setOwner(String value) { this.Owner = value; return this; }
        public Double getValueUSD() { return ValueUSD; }
        public ExecWipRow setValueUSD(Double value) { this.ValueUSD = value; return this; }
        public Double getPctComplete() { return PctComplete; }
        public ExecWipRow setPctComplete(Double value) { this.PctComplete = value; return this; }
        public Double getBilledUSD() { return BilledUSD; }
        public ExecWipRow setBilledUSD(Double value) { this.BilledUSD = value; return this; }
        public Double getOverUnderUSD() { return OverUnderUSD; }
        public ExecWipRow setOverUnderUSD(Double value) { this.OverUnderUSD = value; return this; }
        public Double getMarginPct() { return MarginPct; }
        public ExecWipRow setMarginPct(Double value) { this.MarginPct = value; return this; }
        public Double getFadePts() { return FadePts; }
        public ExecWipRow setFadePts(Double value) { this.FadePts = value; return this; }
    }

    public static class ExecPipelineStage
    {
        public String Stage = null;
        public Double ValueUSD = null;
        public Integer Count = null;
        
        public String getStage() { return Stage; }
        public ExecPipelineStage setStage(String value) { this.Stage = value; return this; }
        public Double getValueUSD() { return ValueUSD; }
        public ExecPipelineStage setValueUSD(Double value) { this.ValueUSD = value; return this; }
        public Integer getCount() { return Count; }
        public ExecPipelineStage setCount(Integer value) { this.Count = value; return this; }
    }

    public static class ExecAgingBucket
    {
        public String Bucket = null;
        public Double AmountUSD = null;
        public Boolean IsRetainage = null;
        
        public String getBucket() { return Bucket; }
        public ExecAgingBucket setBucket(String value) { this.Bucket = value; return this; }
        public Double getAmountUSD() { return AmountUSD; }
        public ExecAgingBucket setAmountUSD(Double value) { this.AmountUSD = value; return this; }
        public Boolean getIsRetainage() { return IsRetainage; }
        public ExecAgingBucket setIsRetainage(Boolean value) { this.IsRetainage = value; return this; }
    }

    public static class ExecSafetyMetric
    {
        public String Label = null;
        public String Value = null;
        public String Sub_ = null;
        public Boolean Good = null;
        
        public String getLabel() { return Label; }
        public ExecSafetyMetric setLabel(String value) { this.Label = value; return this; }
        public String getValue() { return Value; }
        public ExecSafetyMetric setValue(String value) { this.Value = value; return this; }
        public String getSub() { return Sub_; }
        public ExecSafetyMetric setSub(String value) { this.Sub_ = value; return this; }
        public Boolean isGood() { return Good; }
        public ExecSafetyMetric setGood(Boolean value) { this.Good = value; return this; }
    }

}

Java 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>
    <BuildDiag>String</BuildDiag>
    <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>
    <WipTotalCount>0</WipTotalCount>
  </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>