Trendsic Platform Service

<back to all web services

ExecutiveDashboardRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/dashboards/executive
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 ExecKpi() = 
        member val Key:String = null with get,set
        member val Label:String = null with get,set
        member val Value:String = null with get,set
        member val Sub_:String = null with get,set
        member val Delta:String = null with get,set
        member val DeltaUp:Boolean = new Boolean() with get,set
        member val HasDelta:Boolean = new Boolean() with get,set
        member val Good:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type ExecCostCategory() = 
        member val Name:String = null with get,set
        member val CostUSD:Double = new Double() with get,set
        member val BilledUSD:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type ExecMonthPoint() = 
        member val Month:String = null with get,set
        member val RevenueUSD:Double = new Double() with get,set
        member val CostUSD:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type ExecBacklogYear() = 
        member val Year:String = null with get,set
        member val ValueUSD:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type ExecBacklog() = 
        member val TotalUSD:Double = new Double() with get,set
        member val MonthsAhead:Double = new Double() with get,set
        member val AwardsYtdUSD:Double = new Double() with get,set
        member val BurnYtdUSD:Double = new Double() with get,set
        member val ByYear:ResizeArray<ExecBacklogYear> = new ResizeArray<ExecBacklogYear>() with get,set

    [<AllowNullLiteral>]
    type ExecWipRow() = 
        member val ContractId:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Owner:String = null with get,set
        member val ValueUSD:Double = new Double() with get,set
        member val PctComplete:Double = new Double() with get,set
        member val BilledUSD:Double = new Double() with get,set
        member val OverUnderUSD:Double = new Double() with get,set
        member val MarginPct:Double = new Double() with get,set
        member val FadePts:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type ExecPipelineStage() = 
        member val Stage:String = null with get,set
        member val ValueUSD:Double = new Double() with get,set
        member val Count:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type ExecAgingBucket() = 
        member val Bucket:String = null with get,set
        member val AmountUSD:Double = new Double() with get,set
        member val IsRetainage:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type ExecSafetyMetric() = 
        member val Label:String = null with get,set
        member val Value:String = null with get,set
        member val Sub_:String = null with get,set
        member val Good:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type ExecutiveDashboard() = 
        member val Period:String = null with get,set
        member val FromDate:DateTime = new DateTime() with get,set
        member val ToDate:DateTime = new DateTime() with get,set
        member val Fy:Int32 = new Int32() with get,set
        member val Kpis:ResizeArray<ExecKpi> = new ResizeArray<ExecKpi>() with get,set
        member val CostVsBilling:ResizeArray<ExecCostCategory> = new ResizeArray<ExecCostCategory>() with get,set
        member val Monthly:ResizeArray<ExecMonthPoint> = new ResizeArray<ExecMonthPoint>() with get,set
        member val Backlog:ExecBacklog = null with get,set
        member val Wip:ResizeArray<ExecWipRow> = new ResizeArray<ExecWipRow>() with get,set
        member val Pipeline:ResizeArray<ExecPipelineStage> = new ResizeArray<ExecPipelineStage>() with get,set
        member val WinRatePct:Double = new Double() with get,set
        member val Receivables:ResizeArray<ExecAgingBucket> = new ResizeArray<ExecAgingBucket>() with get,set
        member val RetainageUSD:Double = new Double() with get,set
        member val DsoDays:Int32 = new Int32() with get,set
        member val Safety:ResizeArray<ExecSafetyMetric> = new ResizeArray<ExecSafetyMetric>() with get,set

    [<AllowNullLiteral>]
    type ExecutiveDashboardResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Dashboard:ExecutiveDashboard = null with get,set

    [<AllowNullLiteral>]
    type ExecutiveDashboardRequest() = 
        member val Period:String = null with get,set
        member val Region:String = null with get,set
        member val Fy:Nullable<Int32> = new Nullable<Int32>() with get,set

F# 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>