Trendsic Platform Service

ExecutiveDashboardRequest

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


open class ExecutiveDashboardRequest
{
    open var Period:String? = null
    open var Region:String? = null
    open var Fy:Int? = null
}

open class ExecutiveDashboardResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Dashboard:ExecutiveDashboard? = null
}

open class ExecutiveDashboard
{
    open var Period:String? = null
    open var FromDate:Date? = null
    open var ToDate:Date? = null
    open var Fy:Int? = null
    open var Kpis:ArrayList<ExecKpi> = ArrayList<ExecKpi>()
    open var CostVsBilling:ArrayList<ExecCostCategory> = ArrayList<ExecCostCategory>()
    open var Monthly:ArrayList<ExecMonthPoint> = ArrayList<ExecMonthPoint>()
    open var Backlog:ExecBacklog? = null
    open var Wip:ArrayList<ExecWipRow> = ArrayList<ExecWipRow>()
    open var Pipeline:ArrayList<ExecPipelineStage> = ArrayList<ExecPipelineStage>()
    open var WinRatePct:Double? = null
    open var Receivables:ArrayList<ExecAgingBucket> = ArrayList<ExecAgingBucket>()
    open var RetainageUSD:Double? = null
    open var DsoDays:Int? = null
    open var Safety:ArrayList<ExecSafetyMetric> = ArrayList<ExecSafetyMetric>()
}

open class ExecKpi
{
    open var Key:String? = null
    open var Label:String? = null
    open var Value:String? = null
    open var Sub_:String? = null
    open var Delta:String? = null
    open var DeltaUp:Boolean? = null
    open var HasDelta:Boolean? = null
    open var Good:Boolean? = null
}

open class ExecCostCategory
{
    open var Name:String? = null
    open var CostUSD:Double? = null
    open var BilledUSD:Double? = null
}

open class ExecMonthPoint
{
    open var Month:String? = null
    open var RevenueUSD:Double? = null
    open var CostUSD:Double? = null
}

open class ExecBacklog
{
    open var TotalUSD:Double? = null
    open var MonthsAhead:Double? = null
    open var AwardsYtdUSD:Double? = null
    open var BurnYtdUSD:Double? = null
    open var ByYear:ArrayList<ExecBacklogYear> = ArrayList<ExecBacklogYear>()
}

open class ExecBacklogYear
{
    open var Year:String? = null
    open var ValueUSD:Double? = null
}

open class ExecWipRow
{
    open var ContractId:Int? = null
    open var Name:String? = null
    open var Owner:String? = null
    open var ValueUSD:Double? = null
    open var PctComplete:Double? = null
    open var BilledUSD:Double? = null
    open var OverUnderUSD:Double? = null
    open var MarginPct:Double? = null
    open var FadePts:Double? = null
}

open class ExecPipelineStage
{
    open var Stage:String? = null
    open var ValueUSD:Double? = null
    open var Count:Int? = null
}

open class ExecAgingBucket
{
    open var Bucket:String? = null
    open var AmountUSD:Double? = null
    open var IsRetainage:Boolean? = null
}

open class ExecSafetyMetric
{
    open var Label:String? = null
    open var Value:String? = null
    open var Sub_:String? = null
    open var Good:Boolean? = null
}

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