| POST,OPTIONS | /v1/dashboard/finance |
|---|
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 DashboardStatTile() =
member val Key:String = null with get,set
member val Label:String = null with get,set
member val Value:Double = new Double() with get,set
member val PreviousValue:Nullable<Double> = new Nullable<Double>() with get,set
member val Unit:String = null with get,set
member val DeltaPct:Nullable<Double> = new Nullable<Double>() with get,set
[<AllowNullLiteral>]
type DashboardSeriesPoint() =
member val Label:String = null with get,set
member val Value:Double = new Double() with get,set
[<AllowNullLiteral>]
type DashboardSeries() =
member val Name:String = null with get,set
member val Points:ResizeArray<DashboardSeriesPoint> = new ResizeArray<DashboardSeriesPoint>() with get,set
[<AllowNullLiteral>]
type FinanceLocationRow() =
member val LocationName:String = null with get,set
member val ServiceRev:Double = new Double() with get,set
member val ProductRev:Double = new Double() with get,set
member val SubscriptionRev:Double = new Double() with get,set
member val Total:Double = new Double() with get,set
[<AllowNullLiteral>]
type FinanceTopRow() =
member val Name:String = null with get,set
member val Revenue:Double = new Double() with get,set
[<AllowNullLiteral>]
type FinanceSubscriptionInfo() =
member val Mrr:Double = new Double() with get,set
member val Arr:Double = new Double() with get,set
member val ActiveCount:Int32 = new Int32() with get,set
member val NewCount:Int32 = new Int32() with get,set
member val ChurnedCount:Int32 = new Int32() with get,set
member val ChurnRatePct:Double = new Double() with get,set
[<AllowNullLiteral>]
type FinanceResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val Stats:ResizeArray<DashboardStatTile> = new ResizeArray<DashboardStatTile>() with get,set
member val Trend:ResizeArray<DashboardSeries> = new ResizeArray<DashboardSeries>() with get,set
member val SourceMix:DashboardSeries = null with get,set
member val ByLocation:ResizeArray<FinanceLocationRow> = new ResizeArray<FinanceLocationRow>() with get,set
member val TopServices:ResizeArray<FinanceTopRow> = new ResizeArray<FinanceTopRow>() with get,set
member val TopProducts:ResizeArray<FinanceTopRow> = new ResizeArray<FinanceTopRow>() with get,set
member val Subscriptions:FinanceSubscriptionInfo = null with get,set
[<AllowNullLiteral>]
type FinanceRequest() =
member val FromDate:DateTime = new DateTime() with get,set
member val ToDate:DateTime = new DateTime() with get,set
member val LocationIds:ResizeArray<Guid> = new ResizeArray<Guid>() with get,set
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.
POST /v1/dashboard/finance HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FinanceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<FromDate>0001-01-01T00:00:00</FromDate>
<LocationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</LocationIds>
<ToDate>0001-01-01T00:00:00</ToDate>
</FinanceRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FinanceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<ByLocation>
<FinanceLocationRow>
<LocationName>String</LocationName>
<ProductRev>0</ProductRev>
<ServiceRev>0</ServiceRev>
<SubscriptionRev>0</SubscriptionRev>
<Total>0</Total>
</FinanceLocationRow>
</ByLocation>
<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>
<SourceMix>
<Name>String</Name>
<Points>
<DashboardSeriesPoint>
<Label>String</Label>
<Value>0</Value>
</DashboardSeriesPoint>
</Points>
</SourceMix>
<Stats>
<DashboardStatTile>
<Key>String</Key>
<Label>String</Label>
<PreviousValue>0</PreviousValue>
<Unit>String</Unit>
<Value>0</Value>
</DashboardStatTile>
</Stats>
<Subscriptions>
<ActiveCount>0</ActiveCount>
<Arr>0</Arr>
<ChurnRatePct>0</ChurnRatePct>
<ChurnedCount>0</ChurnedCount>
<Mrr>0</Mrr>
<NewCount>0</NewCount>
</Subscriptions>
<TopProducts>
<FinanceTopRow>
<Name>String</Name>
<Revenue>0</Revenue>
</FinanceTopRow>
</TopProducts>
<TopServices>
<FinanceTopRow>
<Name>String</Name>
<Revenue>0</Revenue>
</FinanceTopRow>
</TopServices>
<Trend>
<DashboardSeries>
<Name>String</Name>
<Points>
<DashboardSeriesPoint>
<Label>String</Label>
<Value>0</Value>
</DashboardSeriesPoint>
</Points>
</DashboardSeries>
</Trend>
</FinanceResponse>