| GET,OPTIONS | /v1/dashboards/executive |
|---|
import Foundation
import ServiceStack
public class ExecutiveDashboardRequest : Codable
{
public var period:String
public var region:String
public var fy:Int?
required public init(){}
}
public class ExecutiveDashboardResponse : Codable
{
public var responseStatus:ResponseStatus
public var dashboard:ExecutiveDashboard
required public init(){}
}
public class ExecutiveDashboard : Codable
{
public var period:String
public var fromDate:Date
public var toDate:Date
public var fy:Int
public var kpis:[ExecKpi] = []
public var costVsBilling:[ExecCostCategory] = []
public var monthly:[ExecMonthPoint] = []
public var backlog:ExecBacklog
public var wip:[ExecWipRow] = []
public var pipeline:[ExecPipelineStage] = []
public var winRatePct:Double
public var receivables:[ExecAgingBucket] = []
public var retainageUSD:Double
public var dsoDays:Int
public var safety:[ExecSafetyMetric] = []
required public init(){}
}
public class ExecKpi : Codable
{
public var key:String
public var label:String
public var value:String
public var sub_:String
public var delta:String
public var deltaUp:Bool
public var hasDelta:Bool
public var good:Bool
required public init(){}
}
public class ExecCostCategory : Codable
{
public var name:String
public var costUSD:Double
public var billedUSD:Double
required public init(){}
}
public class ExecMonthPoint : Codable
{
public var month:String
public var revenueUSD:Double
public var costUSD:Double
required public init(){}
}
public class ExecBacklog : Codable
{
public var totalUSD:Double
public var monthsAhead:Double
public var awardsYtdUSD:Double
public var burnYtdUSD:Double
public var byYear:[ExecBacklogYear] = []
required public init(){}
}
public class ExecBacklogYear : Codable
{
public var year:String
public var valueUSD:Double
required public init(){}
}
public class ExecWipRow : Codable
{
public var contractId:Int
public var name:String
public var owner:String
public var valueUSD:Double
public var pctComplete:Double
public var billedUSD:Double
public var overUnderUSD:Double
public var marginPct:Double
public var fadePts:Double
required public init(){}
}
public class ExecPipelineStage : Codable
{
public var stage:String
public var valueUSD:Double
public var count:Int
required public init(){}
}
public class ExecAgingBucket : Codable
{
public var bucket:String
public var amountUSD:Double
public var isRetainage:Bool
required public init(){}
}
public class ExecSafetyMetric : Codable
{
public var label:String
public var value:String
public var sub_:String
public var good:Bool
required public init(){}
}
Swift ExecutiveDashboardRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>