Trendsic Platform Service

<back to all web services

ExecutiveDashboardRequest

export class ExecKpi
{
    public Key: string;
    public Label: string;
    public Value: string;
    public Sub_: string;
    public Delta: string;
    public DeltaUp: boolean;
    public HasDelta: boolean;
    public Good: boolean;

    public constructor(init?: Partial<ExecKpi>) { (Object as any).assign(this, init); }
}

export class ExecCostCategory
{
    public Name: string;
    public CostUSD: number;
    public BilledUSD: number;

    public constructor(init?: Partial<ExecCostCategory>) { (Object as any).assign(this, init); }
}

export class ExecMonthPoint
{
    public Month: string;
    public RevenueUSD: number;
    public CostUSD: number;

    public constructor(init?: Partial<ExecMonthPoint>) { (Object as any).assign(this, init); }
}

export class ExecBacklogYear
{
    public Year: string;
    public ValueUSD: number;

    public constructor(init?: Partial<ExecBacklogYear>) { (Object as any).assign(this, init); }
}

export class ExecBacklog
{
    public TotalUSD: number;
    public MonthsAhead: number;
    public AwardsYtdUSD: number;
    public BurnYtdUSD: number;
    public ByYear: ExecBacklogYear[] = [];

    public constructor(init?: Partial<ExecBacklog>) { (Object as any).assign(this, init); }
}

export class ExecWipRow
{
    public ContractId: number;
    public Name: string;
    public Owner: string;
    public ValueUSD: number;
    public PctComplete: number;
    public BilledUSD: number;
    public OverUnderUSD: number;
    public MarginPct: number;
    public FadePts: number;

    public constructor(init?: Partial<ExecWipRow>) { (Object as any).assign(this, init); }
}

export class ExecPipelineStage
{
    public Stage: string;
    public ValueUSD: number;
    public Count: number;

    public constructor(init?: Partial<ExecPipelineStage>) { (Object as any).assign(this, init); }
}

export class ExecAgingBucket
{
    public Bucket: string;
    public AmountUSD: number;
    public IsRetainage: boolean;

    public constructor(init?: Partial<ExecAgingBucket>) { (Object as any).assign(this, init); }
}

export class ExecSafetyMetric
{
    public Label: string;
    public Value: string;
    public Sub_: string;
    public Good: boolean;

    public constructor(init?: Partial<ExecSafetyMetric>) { (Object as any).assign(this, init); }
}

export class ExecutiveDashboard
{
    public Period: string;
    public FromDate: string;
    public ToDate: string;
    public Fy: number;
    public Kpis: ExecKpi[] = [];
    public CostVsBilling: ExecCostCategory[] = [];
    public Monthly: ExecMonthPoint[] = [];
    public Backlog: ExecBacklog;
    public Wip: ExecWipRow[] = [];
    public Pipeline: ExecPipelineStage[] = [];
    public WinRatePct: number;
    public Receivables: ExecAgingBucket[] = [];
    public RetainageUSD: number;
    public DsoDays: number;
    public Safety: ExecSafetyMetric[] = [];

    public constructor(init?: Partial<ExecutiveDashboard>) { (Object as any).assign(this, init); }
}

export class ExecutiveDashboardResponse
{
    public ResponseStatus: ResponseStatus;
    public Dashboard: ExecutiveDashboard;

    public constructor(init?: Partial<ExecutiveDashboardResponse>) { (Object as any).assign(this, init); }
}

export class ExecutiveDashboardRequest
{
    public Period: string;
    public Region: string;
    public Fy?: number;

    public constructor(init?: Partial<ExecutiveDashboardRequest>) { (Object as any).assign(this, init); }
}

TypeScript ExecutiveDashboardRequest DTOs

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>