Trendsic Platform Service

<back to all web services

ExecutiveDashboardRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/dashboards/executive
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class ExecAgingBucket
            Public Overridable Property Bucket As String
            Public Overridable Property AmountUSD As Double
            Public Overridable Property IsRetainage As Boolean
        End Class

        Public Partial Class ExecBacklog
            Public Overridable Property TotalUSD As Double
            Public Overridable Property MonthsAhead As Double
            Public Overridable Property AwardsYtdUSD As Double
            Public Overridable Property BurnYtdUSD As Double
            Public Overridable Property ByYear As List(Of ExecBacklogYear) = New List(Of ExecBacklogYear)
        End Class

        Public Partial Class ExecBacklogYear
            Public Overridable Property Year As String
            Public Overridable Property ValueUSD As Double
        End Class

        Public Partial Class ExecCostCategory
            Public Overridable Property Name As String
            Public Overridable Property CostUSD As Double
            Public Overridable Property BilledUSD As Double
        End Class

        Public Partial Class ExecKpi
            Public Overridable Property Key As String
            Public Overridable Property Label As String
            Public Overridable Property Value As String
            Public Overridable Property Sub_ As String
            Public Overridable Property Delta As String
            Public Overridable Property DeltaUp As Boolean
            Public Overridable Property HasDelta As Boolean
            Public Overridable Property Good As Boolean
        End Class

        Public Partial Class ExecMonthPoint
            Public Overridable Property Month As String
            Public Overridable Property RevenueUSD As Double
            Public Overridable Property CostUSD As Double
        End Class

        Public Partial Class ExecPipelineStage
            Public Overridable Property Stage As String
            Public Overridable Property ValueUSD As Double
            Public Overridable Property Count As Integer
        End Class

        Public Partial Class ExecSafetyMetric
            Public Overridable Property Label As String
            Public Overridable Property Value As String
            Public Overridable Property Sub_ As String
            Public Overridable Property Good As Boolean
        End Class

        Public Partial Class ExecutiveDashboard
            Public Overridable Property Period As String
            Public Overridable Property FromDate As Date
            Public Overridable Property ToDate As Date
            Public Overridable Property Fy As Integer
            Public Overridable Property Kpis As List(Of ExecKpi) = New List(Of ExecKpi)
            Public Overridable Property CostVsBilling As List(Of ExecCostCategory) = New List(Of ExecCostCategory)
            Public Overridable Property Monthly As List(Of ExecMonthPoint) = New List(Of ExecMonthPoint)
            Public Overridable Property Backlog As ExecBacklog
            Public Overridable Property Wip As List(Of ExecWipRow) = New List(Of ExecWipRow)
            Public Overridable Property Pipeline As List(Of ExecPipelineStage) = New List(Of ExecPipelineStage)
            Public Overridable Property WinRatePct As Double
            Public Overridable Property Receivables As List(Of ExecAgingBucket) = New List(Of ExecAgingBucket)
            Public Overridable Property RetainageUSD As Double
            Public Overridable Property DsoDays As Integer
            Public Overridable Property Safety As List(Of ExecSafetyMetric) = New List(Of ExecSafetyMetric)
        End Class

        Public Partial Class ExecutiveDashboardRequest
            Public Overridable Property Period As String
            Public Overridable Property Region As String
            Public Overridable Property Fy As Integer?
        End Class

        Public Partial Class ExecutiveDashboardResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Dashboard As ExecutiveDashboard
        End Class

        Public Partial Class ExecWipRow
            Public Overridable Property ContractId As Integer
            Public Overridable Property Name As String
            Public Overridable Property Owner As String
            Public Overridable Property ValueUSD As Double
            Public Overridable Property PctComplete As Double
            Public Overridable Property BilledUSD As Double
            Public Overridable Property OverUnderUSD As Double
            Public Overridable Property MarginPct As Double
            Public Overridable Property FadePts As Double
        End Class
    End Namespace
End Namespace

VB.NET 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>