| 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 SvcNamedTime() =
member val Id:Guid = new Guid() with get,set
member val Name:String = null with get,set
member val SignedSec:Int64 = new Int64() with get,set
member val Served:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type SvcTint() =
member val Field:String = null with get,set
member val Tone:String = null with get,set
member val Reason:String = null with get,set
member val Value:Nullable<Double> = new Nullable<Double>() with get,set
member val Reference:Nullable<Double> = new Nullable<Double>() with get,set
member val BranchValue:Nullable<Double> = new Nullable<Double>() with get,set
[<AllowNullLiteral>]
type SvcMetrics() =
member val Checkins:Int32 = new Int32() with get,set
member val Walkins:Int32 = new Int32() with get,set
member val Appts:Int32 = new Int32() with get,set
member val Served:Int32 = new Int32() with get,set
member val NoShows:Int32 = new Int32() with get,set
member val ApptNoShows:Int32 = new Int32() with get,set
member val CancelledAtWindow:Int32 = new Int32() with get,set
member val Abandoned:Int32 = new Int32() with get,set
member val Called:Int32 = new Int32() with get,set
member val CalledUp:Int32 = new Int32() with get,set
member val AbandonRate:Nullable<Double> = new Nullable<Double>() with get,set
member val NoShowRate:Nullable<Double> = new Nullable<Double>() with get,set
member val AvgServiceSec:Nullable<Double> = new Nullable<Double>() with get,set
member val MedianServiceSec:Nullable<Double> = new Nullable<Double>() with get,set
member val AvgWaitSec:Nullable<Double> = new Nullable<Double>() with get,set
member val MaxWaitSec:Int32 = new Int32() with get,set
member val AvgWalkUpSec:Nullable<Double> = new Nullable<Double>() with get,set
member val ExpectedServiceSec:Nullable<Double> = new Nullable<Double>() with get,set
member val SignedSec:Int64 = new Int64() with get,set
member val ServingSec:Int64 = new Int64() with get,set
member val PausedSec:Int64 = new Int64() with get,set
member val IdleSec:Int64 = new Int64() with get,set
member val UnstaffedSec:Int64 = new Int64() with get,set
member val Utilization:Nullable<Double> = new Nullable<Double>() with get,set
member val IdleShare:Nullable<Double> = new Nullable<Double>() with get,set
member val PausedShare:Nullable<Double> = new Nullable<Double>() with get,set
member val Sessions:Int32 = new Int32() with get,set
member val OpenDays:Int32 = new Int32() with get,set
member val FeesEarned:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val AvgFee:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val FeesPerStaffedHour:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val ExpectedFeesPerStaffedHour:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val LaborCost:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val LaborPartial:Boolean = new Boolean() with get,set
member val MissingCostEmployeeIds:ResizeArray<Guid> = new ResizeArray<Guid>() with get,set
member val MissingCost:ResizeArray<SvcNamedTime> = new ResizeArray<SvcNamedTime>() with get,set
member val LaborLocked:Boolean = new Boolean() with get,set
member val Contribution:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val LostFees:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val LostNoShowFees:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val Mix:Dictionary<Guid, Int32> = new Dictionary<Guid, Int32>() with get,set
member val HourlyServed:Int32[] = [||] with get,set
member val HourlyFees:Decimal[] = [||] with get,set
member val HourlyCost:Decimal[] = [||] with get,set
member val Tints:ResizeArray<SvcTint> = new ResizeArray<SvcTint>() with get,set
[<AllowNullLiteral>]
type SvcBranchRow() =
member val BranchId:Guid = new Guid() with get,set
member val Name:String = null with get,set
member val StateCode:String = null with get,set
member val ZoneCode:String = null with get,set
member val TimeZone:String = null with get,set
member val Windows:Int32 = new Int32() with get,set
member val RecordingSinceUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val SessionsSinceUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val Metrics:SvcMetrics = null with get,set
[<AllowNullLiteral>]
type SvcStateRow() =
member val StateCode:String = null with get,set
member val StateName:String = null with get,set
member val Branches:Int32 = new Int32() with get,set
member val Metrics:SvcMetrics = null with get,set
[<AllowNullLiteral>]
type SvcComparison() =
member val Mode:String = null with get,set
member val FromDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val ToDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val CutoffMinute:Nullable<Int32> = new Nullable<Int32>() with get,set
member val HasData:Boolean = new Boolean() with get,set
member val Metrics:SvcMetrics = null with get,set
[<AllowNullLiteral>]
type SvcFeeChange() =
member val LocationId:Guid = new Guid() with get,set
member val OnDate:DateTime = new DateTime() with get,set
member val FromFee:Decimal = new Decimal() with get,set
member val ToFee:Decimal = new Decimal() with get,set
[<AllowNullLiteral>]
type SvcServiceRow() =
member val LineId:Guid = new Guid() with get,set
member val Name:String = null with get,set
member val Completed:Int32 = new Int32() with get,set
member val AvgServiceSec:Nullable<Double> = new Nullable<Double>() with get,set
member val BranchAvgServiceSec:Nullable<Double> = new Nullable<Double>() with get,set
member val FeesEarned:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val FeeCurrent:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val FeeMin:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val FeeMax:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val FeePerMinute:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val BranchFeePerMinute:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val FeeChanges:ResizeArray<SvcFeeChange> = new ResizeArray<SvcFeeChange>() with get,set
[<AllowNullLiteral>]
type SvcHourRow() =
member val LocalHour:Int32 = new Int32() with get,set
member val Served:Int32 = new Int32() with get,set
member val FeesEarned:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val CostToStaff:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<AllowNullLiteral>]
type SvcWorkerRow() =
member val EmployeeId:Guid = new Guid() with get,set
member val BranchId:Guid = new Guid() with get,set
member val BranchName:String = null with get,set
member val Name:String = null with get,set
member val Served:Int32 = new Int32() with get,set
member val AvgServiceSec:Nullable<Double> = new Nullable<Double>() with get,set
member val Utilization:Nullable<Double> = new Nullable<Double>() with get,set
[<AllowNullLiteral>]
type SvcAlert() =
member val Level:String = null with get,set
member val View:String = null with get,set
member val Code:String = null with get,set
member val StationId:Nullable<Guid> = new Nullable<Guid>() with get,set
member val EmployeeId:Nullable<Guid> = new Nullable<Guid>() with get,set
member val BranchId:Nullable<Guid> = new Nullable<Guid>() with get,set
member val LineId:Nullable<Guid> = new Nullable<Guid>() with get,set
member val Name:String = null with get,set
member val OtherLineId:Nullable<Guid> = new Nullable<Guid>() with get,set
member val OtherName:String = null with get,set
member val StationIds:ResizeArray<Guid> = new ResizeArray<Guid>() with get,set
member val Values:Dictionary<String, Double> = new Dictionary<String, Double>() with get,set
[<AllowNullLiteral>]
type SvcScope() =
member val StateCode:String = null with get,set
member val Branches:ResizeArray<SvcBranchRow> = new ResizeArray<SvcBranchRow>() with get,set
member val States:ResizeArray<SvcStateRow> = new ResizeArray<SvcStateRow>() with get,set
member val Total:SvcMetrics = null with get,set
member val Comparison:SvcComparison = null with get,set
member val FeesByService:ResizeArray<SvcServiceRow> = new ResizeArray<SvcServiceRow>() with get,set
member val ByHour:ResizeArray<SvcHourRow> = new ResizeArray<SvcHourRow>() with get,set
member val Workers:ResizeArray<SvcWorkerRow> = new ResizeArray<SvcWorkerRow>() with get,set
member val MultiZone:Boolean = new Boolean() with get,set
member val MultiState:Boolean = new Boolean() with get,set
member val RecordingSinceUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val SessionsSinceUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val Alerts:ResizeArray<SvcAlert> = new ResizeArray<SvcAlert>() with get,set
member val CanSeeStaff:Boolean = new Boolean() with get,set
member val CanSeeFinancial:Boolean = new Boolean() with get,set
member val CanSeePay:Boolean = new Boolean() 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
member val Scope:SvcScope = null 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
member val IncludeScope:Boolean = new Boolean() with get,set
member val StateCode:String = null with get,set
member val Compare:String = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
FromDate: 0001-01-01,
ToDate: 0001-01-01,
LocationIds:
[
00000000000000000000000000000000
],
IncludeScope: False,
StateCode: String,
Compare: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
Stats:
[
{
Key: String,
Label: String,
Value: 0,
PreviousValue: 0,
Unit: String
}
],
Trend:
[
{
Name: String,
Points:
[
{
Label: String,
Value: 0
}
]
}
],
ServicesByType:
{
Name: String,
Points:
[
{
Label: String,
Value: 0
}
]
},
LocationLeaderboard:
[
{
LocationName: String,
Walkins: 0,
Completed: 0,
AvgServiceMinutes: 0,
AbandonmentPct: 0
}
],
WorkerProductivity:
[
{
WorkerName: String,
Completed: 0,
AvgServiceMinutes: 0
}
],
Heatmap:
[
{
Dow: 0,
Hr: 0,
Cnt: 0
}
],
LiveQueue:
[
{
LocationName: String,
Waiting: 0,
InProgress: 0
}
],
Scope:
{
StateCode: String,
Branches:
[
{
BranchId: 00000000000000000000000000000000,
Name: String,
StateCode: String,
ZoneCode: String,
TimeZone: String,
Windows: 0,
RecordingSinceUtc: 0001-01-01,
SessionsSinceUtc: 0001-01-01,
Metrics:
{
Checkins: 0,
Walkins: 0,
Appts: 0,
Served: 0,
NoShows: 0,
ApptNoShows: 0,
CancelledAtWindow: 0,
Abandoned: 0,
Called: 0,
CalledUp: 0,
AbandonRate: 0,
NoShowRate: 0,
AvgServiceSec: 0,
MedianServiceSec: 0,
AvgWaitSec: 0,
MaxWaitSec: 0,
AvgWalkUpSec: 0,
ExpectedServiceSec: 0,
SignedSec: 0,
ServingSec: 0,
PausedSec: 0,
IdleSec: 0,
UnstaffedSec: 0,
Utilization: 0,
IdleShare: 0,
PausedShare: 0,
Sessions: 0,
OpenDays: 0,
FeesEarned: 0,
AvgFee: 0,
FeesPerStaffedHour: 0,
ExpectedFeesPerStaffedHour: 0,
LaborCost: 0,
LaborPartial: False,
MissingCostEmployeeIds:
[
00000000000000000000000000000000
],
MissingCost:
[
{
Id: 00000000000000000000000000000000,
Name: String,
SignedSec: 0,
Served: 0
}
],
LaborLocked: False,
Contribution: 0,
LostFees: 0,
LostNoShowFees: 0,
Mix:
{
00000000000000000000000000000000: 0
},
HourlyServed:
[
0
],
HourlyFees:
[
0
],
HourlyCost:
[
0
],
Tints:
[
{
Field: String,
Tone: String,
Reason: String,
Value: 0,
Reference: 0,
BranchValue: 0
}
]
}
}
],
States:
[
{
StateCode: String,
StateName: String,
Branches: 0,
Metrics:
{
Checkins: 0,
Walkins: 0,
Appts: 0,
Served: 0,
NoShows: 0,
ApptNoShows: 0,
CancelledAtWindow: 0,
Abandoned: 0,
Called: 0,
CalledUp: 0,
AbandonRate: 0,
NoShowRate: 0,
AvgServiceSec: 0,
MedianServiceSec: 0,
AvgWaitSec: 0,
MaxWaitSec: 0,
AvgWalkUpSec: 0,
ExpectedServiceSec: 0,
SignedSec: 0,
ServingSec: 0,
PausedSec: 0,
IdleSec: 0,
UnstaffedSec: 0,
Utilization: 0,
IdleShare: 0,
PausedShare: 0,
Sessions: 0,
OpenDays: 0,
FeesEarned: 0,
AvgFee: 0,
FeesPerStaffedHour: 0,
ExpectedFeesPerStaffedHour: 0,
LaborCost: 0,
LaborPartial: False,
MissingCostEmployeeIds:
[
00000000000000000000000000000000
],
MissingCost:
[
{
Id: 00000000000000000000000000000000,
Name: String,
SignedSec: 0,
Served: 0
}
],
LaborLocked: False,
Contribution: 0,
LostFees: 0,
LostNoShowFees: 0,
Mix:
{
00000000000000000000000000000000: 0
},
HourlyServed:
[
0
],
HourlyFees:
[
0
],
HourlyCost:
[
0
],
Tints:
[
{
Field: String,
Tone: String,
Reason: String,
Value: 0,
Reference: 0,
BranchValue: 0
}
]
}
}
],
Total:
{
Checkins: 0,
Walkins: 0,
Appts: 0,
Served: 0,
NoShows: 0,
ApptNoShows: 0,
CancelledAtWindow: 0,
Abandoned: 0,
Called: 0,
CalledUp: 0,
AbandonRate: 0,
NoShowRate: 0,
AvgServiceSec: 0,
MedianServiceSec: 0,
AvgWaitSec: 0,
MaxWaitSec: 0,
AvgWalkUpSec: 0,
ExpectedServiceSec: 0,
SignedSec: 0,
ServingSec: 0,
PausedSec: 0,
IdleSec: 0,
UnstaffedSec: 0,
Utilization: 0,
IdleShare: 0,
PausedShare: 0,
Sessions: 0,
OpenDays: 0,
FeesEarned: 0,
AvgFee: 0,
FeesPerStaffedHour: 0,
ExpectedFeesPerStaffedHour: 0,
LaborCost: 0,
LaborPartial: False,
MissingCostEmployeeIds:
[
00000000000000000000000000000000
],
MissingCost:
[
{
Id: 00000000000000000000000000000000,
Name: String,
SignedSec: 0,
Served: 0
}
],
LaborLocked: False,
Contribution: 0,
LostFees: 0,
LostNoShowFees: 0,
Mix:
{
00000000000000000000000000000000: 0
},
HourlyServed:
[
0
],
HourlyFees:
[
0
],
HourlyCost:
[
0
],
Tints:
[
{
Field: String,
Tone: String,
Reason: String,
Value: 0,
Reference: 0,
BranchValue: 0
}
]
},
Comparison:
{
Mode: String,
FromDate: 0001-01-01,
ToDate: 0001-01-01,
CutoffMinute: 0,
HasData: False,
Metrics:
{
Checkins: 0,
Walkins: 0,
Appts: 0,
Served: 0,
NoShows: 0,
ApptNoShows: 0,
CancelledAtWindow: 0,
Abandoned: 0,
Called: 0,
CalledUp: 0,
AbandonRate: 0,
NoShowRate: 0,
AvgServiceSec: 0,
MedianServiceSec: 0,
AvgWaitSec: 0,
MaxWaitSec: 0,
AvgWalkUpSec: 0,
ExpectedServiceSec: 0,
SignedSec: 0,
ServingSec: 0,
PausedSec: 0,
IdleSec: 0,
UnstaffedSec: 0,
Utilization: 0,
IdleShare: 0,
PausedShare: 0,
Sessions: 0,
OpenDays: 0,
FeesEarned: 0,
AvgFee: 0,
FeesPerStaffedHour: 0,
ExpectedFeesPerStaffedHour: 0,
LaborCost: 0,
LaborPartial: False,
MissingCostEmployeeIds:
[
00000000000000000000000000000000
],
MissingCost:
[
{
Id: 00000000000000000000000000000000,
Name: String,
SignedSec: 0,
Served: 0
}
],
LaborLocked: False,
Contribution: 0,
LostFees: 0,
LostNoShowFees: 0,
Mix:
{
00000000000000000000000000000000: 0
},
HourlyServed:
[
0
],
HourlyFees:
[
0
],
HourlyCost:
[
0
],
Tints:
[
{
Field: String,
Tone: String,
Reason: String,
Value: 0,
Reference: 0,
BranchValue: 0
}
]
}
},
FeesByService:
[
{
LineId: 00000000000000000000000000000000,
Name: String,
Completed: 0,
AvgServiceSec: 0,
BranchAvgServiceSec: 0,
FeesEarned: 0,
FeeCurrent: 0,
FeeMin: 0,
FeeMax: 0,
FeePerMinute: 0,
BranchFeePerMinute: 0,
FeeChanges:
[
{
LocationId: 00000000000000000000000000000000,
OnDate: 0001-01-01,
FromFee: 0,
ToFee: 0
}
]
}
],
ByHour:
[
{
LocalHour: 0,
Served: 0,
FeesEarned: 0,
CostToStaff: 0
}
],
Workers:
[
{
EmployeeId: 00000000000000000000000000000000,
BranchId: 00000000000000000000000000000000,
BranchName: String,
Name: String,
Served: 0,
AvgServiceSec: 0,
Utilization: 0
}
],
MultiZone: False,
MultiState: False,
RecordingSinceUtc: 0001-01-01,
SessionsSinceUtc: 0001-01-01,
Alerts:
[
{
Level: String,
View: String,
Code: String,
StationId: 00000000000000000000000000000000,
EmployeeId: 00000000000000000000000000000000,
BranchId: 00000000000000000000000000000000,
LineId: 00000000000000000000000000000000,
Name: String,
OtherLineId: 00000000000000000000000000000000,
OtherName: String,
StationIds:
[
00000000000000000000000000000000
],
Values:
{
String: 0
}
}
],
CanSeeStaff: False,
CanSeeFinancial: False,
CanSeePay: False
}
}