| 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 .other suffix or ?format=other
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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Dashboard":{"Period":"String","FromDate":"0001-01-01T00:00:00.0000000","ToDate":"0001-01-01T00:00:00.0000000","Fy":0,"Kpis":[{"Key":"String","Label":"String","Value":"String","Sub_":"String","Delta":"String","DeltaUp":false,"HasDelta":false,"Good":false}],"CostVsBilling":[{"Name":"String","CostUSD":0,"BilledUSD":0}],"Monthly":[{"Month":"String","RevenueUSD":0,"CostUSD":0}],"Backlog":{"TotalUSD":0,"MonthsAhead":0,"AwardsYtdUSD":0,"BurnYtdUSD":0,"ByYear":[{"Year":"String","ValueUSD":0}]},"Wip":[{"ContractId":0,"Name":"String","Owner":"String","ValueUSD":0,"PctComplete":0,"BilledUSD":0,"OverUnderUSD":0,"MarginPct":0,"FadePts":0}],"Pipeline":[{"Stage":"String","ValueUSD":0,"Count":0}],"WinRatePct":0,"Receivables":[{"Bucket":"String","AmountUSD":0,"IsRetainage":false}],"RetainageUSD":0,"DsoDays":0,"Safety":[{"Label":"String","Value":"String","Sub_":"String","Good":false}]}}