Trendsic Platform Service

<back to all web services

KpiV2BranchRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dashboard/kpiv2/branch
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class KpiV2BranchRequest
{
    open var BranchId:UUID? = null
    open var FromDate:Date? = null
    open var ToDate:Date? = null
    open var Compare:String? = null
}

open class KpiV2BranchResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Branch:SvcBranchDetail? = null
}

open class SvcBranchDetail
{
    open var Branch:SvcBranchRow? = null
    open var Windows:ArrayList<SvcWindowRow> = ArrayList<SvcWindowRow>()
    open var Clerks:ArrayList<SvcClerkRow> = ArrayList<SvcClerkRow>()
    open var Unassigned:SvcMetrics? = null
    open var NoClerk:SvcMetrics? = null
    open var PerWindowAverage:SvcAverage? = null
    open var PerClerkAverage:SvcAverage? = null
    open var OpenDays:Int? = null
    open var IsLive:Boolean? = null
    open var Comparison:SvcComparison? = null
    open var Coverage:SvcCoverage? = null
    open var Services:ArrayList<SvcServiceRow> = ArrayList<SvcServiceRow>()
    open var ByHour:ArrayList<SvcHourRow> = ArrayList<SvcHourRow>()
    open var Alerts:ArrayList<SvcAlert> = ArrayList<SvcAlert>()
    open var TotalsAgree:Boolean? = null
    open var CanSeeStaff:Boolean? = null
    open var CanSeeFinancial:Boolean? = null
    open var CanSeePay:Boolean? = null
}

open class SvcBranchRow
{
    open var BranchId:UUID? = null
    open var Name:String? = null
    open var StateCode:String? = null
    open var ZoneCode:String? = null
    open var TimeZone:String? = null
    open var Windows:Int? = null
    open var RecordingSinceUtc:Date? = null
    open var SessionsSinceUtc:Date? = null
    open var Metrics:SvcMetrics? = null
}

open class SvcMetrics
{
    open var Checkins:Int? = null
    open var Walkins:Int? = null
    open var Appts:Int? = null
    open var Served:Int? = null
    open var NoShows:Int? = null
    open var ApptNoShows:Int? = null
    open var CancelledAtWindow:Int? = null
    open var Abandoned:Int? = null
    open var Called:Int? = null
    open var CalledUp:Int? = null
    open var AbandonRate:Double? = null
    open var NoShowRate:Double? = null
    open var AvgServiceSec:Double? = null
    open var MedianServiceSec:Double? = null
    open var AvgWaitSec:Double? = null
    open var MaxWaitSec:Int? = null
    open var AvgWalkUpSec:Double? = null
    open var ExpectedServiceSec:Double? = null
    open var SignedSec:Long? = null
    open var ServingSec:Long? = null
    open var PausedSec:Long? = null
    open var IdleSec:Long? = null
    open var UnstaffedSec:Long? = null
    open var Utilization:Double? = null
    open var IdleShare:Double? = null
    open var PausedShare:Double? = null
    open var Sessions:Int? = null
    open var OpenDays:Int? = null
    open var FeesEarned:BigDecimal? = null
    open var AvgFee:BigDecimal? = null
    open var FeesPerStaffedHour:BigDecimal? = null
    open var ExpectedFeesPerStaffedHour:BigDecimal? = null
    open var LaborCost:BigDecimal? = null
    open var LaborPartial:Boolean? = null
    open var MissingCostEmployeeIds:ArrayList<UUID> = ArrayList<UUID>()
    open var MissingCost:ArrayList<SvcNamedTime> = ArrayList<SvcNamedTime>()
    open var LaborLocked:Boolean? = null
    open var Contribution:BigDecimal? = null
    open var LostFees:BigDecimal? = null
    open var LostNoShowFees:BigDecimal? = null
    open var Mix:HashMap<UUID,Int> = HashMap<UUID,Int>()
    open var HourlyServed:ArrayList<Int> = ArrayList<Int>()
    open var HourlyFees:ArrayList<BigDecimal> = ArrayList<BigDecimal>()
    open var HourlyCost:ArrayList<BigDecimal> = ArrayList<BigDecimal>()
    open var Tints:ArrayList<SvcTint> = ArrayList<SvcTint>()
}

open class SvcNamedTime
{
    open var Id:UUID? = null
    open var Name:String? = null
    open var SignedSec:Long? = null
    open var Served:Int? = null
}

open class SvcTint
{
    open var Field:String? = null
    open var Tone:String? = null
    open var Reason:String? = null
    open var Value:Double? = null
    open var Reference:Double? = null
    open var BranchValue:Double? = null
}

open class SvcWindowRow
{
    open var StationId:UUID? = null
    open var Name:String? = null
    open var Clerks:ArrayList<SvcNamedTime> = ArrayList<SvcNamedTime>()
    open var NeverStaffed:Boolean? = null
    open var LastStaffedUtc:Date? = null
    open var LastStaffedBy:String? = null
    open var Metrics:SvcMetrics? = null
}

open class SvcClerkRow
{
    open var EmployeeId:UUID? = null
    open var Name:String? = null
    open var Windows:ArrayList<SvcNamedTime> = ArrayList<SvcNamedTime>()
    open var LoadedRate:BigDecimal? = null
    open var RateSet:Boolean? = null
    open var RateLocked:Boolean? = null
    open var Metrics:SvcMetrics? = null
}

open class SvcAverage
{
    open var Count:Int? = null
    open var Served:Double? = null
    open var AvgServiceSec:Double? = null
    open var MedianServiceSec:Double? = null
    open var AvgWaitSec:Double? = null
    open var Utilization:Double? = null
    open var IdleSec:Double? = null
    open var PausedSec:Double? = null
    open var NoShows:Double? = null
    open var SignedSec:Double? = null
    open var FeesEarned:BigDecimal? = null
    open var FeesPerStaffedHour:BigDecimal? = null
    open var LaborCost:BigDecimal? = null
    open var Contribution:BigDecimal? = null
    open var LostNoShowFees:BigDecimal? = null
}

open class SvcComparison
{
    open var Mode:String? = null
    open var FromDate:Date? = null
    open var ToDate:Date? = null
    open var CutoffMinute:Int? = null
    open var HasData:Boolean? = null
    open var Metrics:SvcMetrics? = null
}

open class SvcCoverage
{
    open var StartLocalMinute:Int? = null
    open var BucketMinutes:Int? = null
    open var Rows:ArrayList<SvcCoverageRow> = ArrayList<SvcCoverageRow>()
    open var InLine:ArrayList<Double> = ArrayList<Double>()
    open var GapBands:ArrayList<ArrayList<Int>> = ArrayList<ArrayList<Int>>()
    open var Days:Int? = null
    open var NotRecorded:Boolean? = null
    open var FutureFromIndex:Int? = null
}

open class SvcCoverageRow
{
    open var StationId:UUID? = null
    open var Name:String? = null
    open var Buckets:ArrayList<SvcCoverageBucket> = ArrayList<SvcCoverageBucket>()
}

open class SvcCoverageBucket
{
    open var ServingPct:Double? = null
    open var IdlePct:Double? = null
    open var PausedPct:Double? = null
    open var UnstaffedPct:Double? = null
}

open class SvcServiceRow
{
    open var LineId:UUID? = null
    open var Name:String? = null
    open var Completed:Int? = null
    open var AvgServiceSec:Double? = null
    open var BranchAvgServiceSec:Double? = null
    open var FeesEarned:BigDecimal? = null
    open var FeeCurrent:BigDecimal? = null
    open var FeeMin:BigDecimal? = null
    open var FeeMax:BigDecimal? = null
    open var FeePerMinute:BigDecimal? = null
    open var BranchFeePerMinute:BigDecimal? = null
    open var FeeChanges:ArrayList<SvcFeeChange> = ArrayList<SvcFeeChange>()
}

open class SvcFeeChange
{
    open var LocationId:UUID? = null
    open var OnDate:Date? = null
    open var FromFee:BigDecimal? = null
    open var ToFee:BigDecimal? = null
}

open class SvcHourRow
{
    open var LocalHour:Int? = null
    open var Served:Int? = null
    open var FeesEarned:BigDecimal? = null
    open var CostToStaff:BigDecimal? = null
}

open class SvcAlert
{
    open var Level:String? = null
    open var View:String? = null
    open var Code:String? = null
    open var StationId:UUID? = null
    open var EmployeeId:UUID? = null
    open var BranchId:UUID? = null
    open var LineId:UUID? = null
    open var Name:String? = null
    open var OtherLineId:UUID? = null
    open var OtherName:String? = null
    open var StationIds:ArrayList<UUID> = ArrayList<UUID>()
    open var Values:HashMap<String,Double> = HashMap<String,Double>()
}

Kotlin KpiV2BranchRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/dashboard/kpiv2/branch HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	BranchId: 00000000000000000000000000000000,
	FromDate: 0001-01-01,
	ToDate: 0001-01-01,
	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
		}
	},
	Branch: 
	{
		Branch: 
		{
			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
					}
				]
			}
		},
		Windows: 
		[
			{
				StationId: 00000000000000000000000000000000,
				Name: String,
				Clerks: 
				[
					{
						Id: 00000000000000000000000000000000,
						Name: String,
						SignedSec: 0,
						Served: 0
					}
				],
				NeverStaffed: False,
				LastStaffedUtc: 0001-01-01,
				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
						}
					]
				}
			}
		],
		Clerks: 
		[
			{
				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
						}
					]
				}
			}
		],
		Unassigned: 
		{
			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
				}
			]
		},
		NoClerk: 
		{
			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
				}
			]
		},
		PerWindowAverage: 
		{
			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
		},
		PerClerkAverage: 
		{
			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
		},
		OpenDays: 0,
		IsLive: False,
		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
					}
				]
			}
		},
		Coverage: 
		{
			StartLocalMinute: 0,
			BucketMinutes: 0,
			Rows: 
			[
				{
					StationId: 00000000000000000000000000000000,
					Name: String,
					Buckets: 
					[
						{
							ServingPct: 0,
							IdlePct: 0,
							PausedPct: 0,
							UnstaffedPct: 0
						}
					]
				}
			],
			InLine: 
			[
				0
			],
			GapBands: 
			[
				[
					0
				]
			],
			Days: 0,
			NotRecorded: False,
			FutureFromIndex: 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-01,
						FromFee: 0,
						ToFee: 0
					}
				]
			}
		],
		ByHour: 
		[
			{
				LocalHour: 0,
				Served: 0,
				FeesEarned: 0,
				CostToStaff: 0
			}
		],
		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
				}
			}
		],
		TotalsAgree: False,
		CanSeeStaff: False,
		CanSeeFinancial: False,
		CanSeePay: False
	}
}