| POST,OPTIONS | /v1/dashboard/kpiv2/detail |
|---|
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 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 SvcWindowRow() =
member val StationId:Guid = new Guid() with get,set
member val Name:String = null with get,set
member val Clerks:ResizeArray<SvcNamedTime> = new ResizeArray<SvcNamedTime>() with get,set
member val NeverStaffed:Boolean = new Boolean() with get,set
member val LastStaffedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val LastStaffedBy:String = null with get,set
member val Metrics:SvcMetrics = null with get,set
[<AllowNullLiteral>]
type SvcClerkRow() =
member val EmployeeId:Guid = new Guid() with get,set
member val Name:String = null with get,set
member val Windows:ResizeArray<SvcNamedTime> = new ResizeArray<SvcNamedTime>() with get,set
member val LoadedRate:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val RateSet:Boolean = new Boolean() with get,set
member val RateLocked:Boolean = new Boolean() with get,set
member val Metrics:SvcMetrics = null with get,set
[<AllowNullLiteral>]
type SvcAverage() =
member val Count:Int32 = new Int32() with get,set
member val Served:Double = new 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 Utilization:Nullable<Double> = new Nullable<Double>() with get,set
member val IdleSec:Double = new Double() with get,set
member val PausedSec:Double = new Double() with get,set
member val NoShows:Double = new Double() with get,set
member val SignedSec:Double = new Double() with get,set
member val FeesEarned:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val FeesPerStaffedHour:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val LaborCost:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val Contribution:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val LostNoShowFees:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<AllowNullLiteral>]
type SvcSession() =
member val SessionId:Guid = new Guid() with get,set
member val StationId:Guid = new Guid() with get,set
member val StationName:String = null with get,set
member val EmployeeId:Guid = new Guid() with get,set
member val EmployeeName:String = null with get,set
member val LocalIn:DateTime = new DateTime() with get,set
member val LocalOut:DateTime = new DateTime() with get,set
member val IsOpen:Boolean = new Boolean() with get,set
member val EndReason:String = null with get,set
member val PausedSec:Int64 = new Int64() 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 SvcDetail() =
member val Kind:String = null with get,set
member val Window:SvcWindowRow = null with get,set
member val Clerk:SvcClerkRow = null with get,set
member val BranchMetrics:SvcMetrics = null with get,set
member val PerRowAverage:SvcAverage = null with get,set
member val Sessions:ResizeArray<SvcSession> = new ResizeArray<SvcSession>() with get,set
member val Services:ResizeArray<SvcServiceRow> = new ResizeArray<SvcServiceRow>() 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 KpiV2DetailResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val Detail:SvcDetail = null with get,set
[<AllowNullLiteral>]
type KpiV2DetailRequest() =
member val BranchId:Guid = new Guid() 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 FromDate:DateTime = new DateTime() with get,set
member val ToDate:DateTime = new DateTime() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/dashboard/kpiv2/detail HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"BranchId":"00000000000000000000000000000000","StationId":"00000000000000000000000000000000","EmployeeId":"00000000000000000000000000000000","FromDate":"0001-01-01T00:00:00.0000000","ToDate":"0001-01-01T00:00:00.0000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Detail":{"Kind":"String","Window":{"StationId":"00000000000000000000000000000000","Name":"String","Clerks":[{"Id":"00000000000000000000000000000000","Name":"String","SignedSec":0,"Served":0}],"NeverStaffed":false,"LastStaffedUtc":"0001-01-01T00:00:00.0000000","LastStaffedBy":"String","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}]}},"Clerk":{"EmployeeId":"00000000000000000000000000000000","Name":"String","Windows":[{"Id":"00000000000000000000000000000000","Name":"String","SignedSec":0,"Served":0}],"LoadedRate":0,"RateSet":false,"RateLocked":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}]}},"BranchMetrics":{"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}]},"PerRowAverage":{"Count":0,"Served":0,"AvgServiceSec":0,"MedianServiceSec":0,"AvgWaitSec":0,"Utilization":0,"IdleSec":0,"PausedSec":0,"NoShows":0,"SignedSec":0,"FeesEarned":0,"FeesPerStaffedHour":0,"LaborCost":0,"Contribution":0,"LostNoShowFees":0},"Sessions":[{"SessionId":"00000000000000000000000000000000","StationId":"00000000000000000000000000000000","StationName":"String","EmployeeId":"00000000000000000000000000000000","EmployeeName":"String","LocalIn":"0001-01-01T00:00:00.0000000","LocalOut":"0001-01-01T00:00:00.0000000","IsOpen":false,"EndReason":"String","PausedSec":0}],"Services":[{"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-01T00:00:00.0000000","FromFee":0,"ToFee":0}]}],"CanSeeStaff":false,"CanSeeFinancial":false,"CanSeePay":false}}