| POST,OPTIONS | /v1/dashboard/kpiv2 |
|---|
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 KpiV2LocationRow() =
member val LocationName:String = null with get,set
member val Walkins:Int32 = new Int32() with get,set
member val Completed:Int32 = new Int32() with get,set
member val AvgServiceMinutes:Double = new Double() with get,set
member val AbandonmentPct:Double = new Double() with get,set
[<AllowNullLiteral>]
type KpiV2WorkerRow() =
member val WorkerName:String = null with get,set
member val Completed:Int32 = new Int32() with get,set
member val AvgServiceMinutes:Double = new Double() with get,set
[<AllowNullLiteral>]
type KpiV2HeatPoint() =
member val Dow:Int32 = new Int32() with get,set
member val Hr:Int32 = new Int32() with get,set
member val Cnt:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type KpiV2LiveRow() =
member val LocationName:String = null with get,set
member val Waiting:Int32 = new Int32() with get,set
member val InProgress:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type KpiV2Response() =
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 ServicesByType:DashboardSeries = null with get,set
member val LocationLeaderboard:ResizeArray<KpiV2LocationRow> = new ResizeArray<KpiV2LocationRow>() with get,set
member val WorkerProductivity:ResizeArray<KpiV2WorkerRow> = new ResizeArray<KpiV2WorkerRow>() with get,set
member val Heatmap:ResizeArray<KpiV2HeatPoint> = new ResizeArray<KpiV2HeatPoint>() with get,set
member val LiveQueue:ResizeArray<KpiV2LiveRow> = new ResizeArray<KpiV2LiveRow>() with get,set
[<AllowNullLiteral>]
type KpiV2Request() =
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/kpiv2 HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<KpiV2Request 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>
</KpiV2Request>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<KpiV2Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Heatmap>
<KpiV2HeatPoint>
<Cnt>0</Cnt>
<Dow>0</Dow>
<Hr>0</Hr>
</KpiV2HeatPoint>
</Heatmap>
<LiveQueue>
<KpiV2LiveRow>
<InProgress>0</InProgress>
<LocationName>String</LocationName>
<Waiting>0</Waiting>
</KpiV2LiveRow>
</LiveQueue>
<LocationLeaderboard>
<KpiV2LocationRow>
<AbandonmentPct>0</AbandonmentPct>
<AvgServiceMinutes>0</AvgServiceMinutes>
<Completed>0</Completed>
<LocationName>String</LocationName>
<Walkins>0</Walkins>
</KpiV2LocationRow>
</LocationLeaderboard>
<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>
<ServicesByType>
<Name>String</Name>
<Points>
<DashboardSeriesPoint>
<Label>String</Label>
<Value>0</Value>
</DashboardSeriesPoint>
</Points>
</ServicesByType>
<Stats>
<DashboardStatTile>
<Key>String</Key>
<Label>String</Label>
<PreviousValue>0</PreviousValue>
<Unit>String</Unit>
<Value>0</Value>
</DashboardStatTile>
</Stats>
<Trend>
<DashboardSeries>
<Name>String</Name>
<Points>
<DashboardSeriesPoint>
<Label>String</Label>
<Value>0</Value>
</DashboardSeriesPoint>
</Points>
</DashboardSeries>
</Trend>
<WorkerProductivity>
<KpiV2WorkerRow>
<AvgServiceMinutes>0</AvgServiceMinutes>
<Completed>0</Completed>
<WorkerName>String</WorkerName>
</KpiV2WorkerRow>
</WorkerProductivity>
</KpiV2Response>