| POST,OPTIONS | /v1/dashboard/kpiv2/detail |
|---|
"use strict";
export class SvcNamedTime {
/** @param {{Id?:string,Name?:string,SignedSec?:number,Served?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Id;
/** @type {string} */
Name;
/** @type {number} */
SignedSec;
/** @type {number} */
Served;
}
export class SvcTint {
/** @param {{Field?:string,Tone?:string,Reason?:string,Value?:number,Reference?:number,BranchValue?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Field;
/** @type {string} */
Tone;
/** @type {string} */
Reason;
/** @type {?number} */
Value;
/** @type {?number} */
Reference;
/** @type {?number} */
BranchValue;
}
export class SvcMetrics {
/** @param {{Checkins?:number,Walkins?:number,Appts?:number,Served?:number,NoShows?:number,ApptNoShows?:number,CancelledAtWindow?:number,Abandoned?:number,Called?:number,CalledUp?:number,AbandonRate?:number,NoShowRate?:number,AvgServiceSec?:number,MedianServiceSec?:number,AvgWaitSec?:number,MaxWaitSec?:number,AvgWalkUpSec?:number,ExpectedServiceSec?:number,SignedSec?:number,ServingSec?:number,PausedSec?:number,IdleSec?:number,UnstaffedSec?:number,Utilization?:number,IdleShare?:number,PausedShare?:number,Sessions?:number,OpenDays?:number,FeesEarned?:number,AvgFee?:number,FeesPerStaffedHour?:number,ExpectedFeesPerStaffedHour?:number,LaborCost?:number,LaborPartial?:boolean,MissingCostEmployeeIds?:string[],MissingCost?:SvcNamedTime[],LaborLocked?:boolean,Contribution?:number,LostFees?:number,LostNoShowFees?:number,Mix?:{ [index:string]: number; },HourlyServed?:number[],HourlyFees?:number[],HourlyCost?:number[],Tints?:SvcTint[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Checkins;
/** @type {number} */
Walkins;
/** @type {number} */
Appts;
/** @type {number} */
Served;
/** @type {number} */
NoShows;
/** @type {number} */
ApptNoShows;
/** @type {number} */
CancelledAtWindow;
/** @type {number} */
Abandoned;
/** @type {number} */
Called;
/** @type {number} */
CalledUp;
/** @type {?number} */
AbandonRate;
/** @type {?number} */
NoShowRate;
/** @type {?number} */
AvgServiceSec;
/** @type {?number} */
MedianServiceSec;
/** @type {?number} */
AvgWaitSec;
/** @type {number} */
MaxWaitSec;
/** @type {?number} */
AvgWalkUpSec;
/** @type {?number} */
ExpectedServiceSec;
/** @type {number} */
SignedSec;
/** @type {number} */
ServingSec;
/** @type {number} */
PausedSec;
/** @type {number} */
IdleSec;
/** @type {number} */
UnstaffedSec;
/** @type {?number} */
Utilization;
/** @type {?number} */
IdleShare;
/** @type {?number} */
PausedShare;
/** @type {number} */
Sessions;
/** @type {number} */
OpenDays;
/** @type {?number} */
FeesEarned;
/** @type {?number} */
AvgFee;
/** @type {?number} */
FeesPerStaffedHour;
/** @type {?number} */
ExpectedFeesPerStaffedHour;
/** @type {?number} */
LaborCost;
/** @type {boolean} */
LaborPartial;
/** @type {string[]} */
MissingCostEmployeeIds = [];
/** @type {SvcNamedTime[]} */
MissingCost = [];
/** @type {boolean} */
LaborLocked;
/** @type {?number} */
Contribution;
/** @type {?number} */
LostFees;
/** @type {?number} */
LostNoShowFees;
/** @type {{ [index:string]: number; }} */
Mix = {};
/** @type {number[]} */
HourlyServed = [];
/** @type {number[]} */
HourlyFees = [];
/** @type {number[]} */
HourlyCost = [];
/** @type {SvcTint[]} */
Tints = [];
}
export class SvcWindowRow {
/** @param {{StationId?:string,Name?:string,Clerks?:SvcNamedTime[],NeverStaffed?:boolean,LastStaffedUtc?:string,LastStaffedBy?:string,Metrics?:SvcMetrics}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
StationId;
/** @type {string} */
Name;
/** @type {SvcNamedTime[]} */
Clerks = [];
/** @type {boolean} */
NeverStaffed;
/** @type {?string} */
LastStaffedUtc;
/** @type {string} */
LastStaffedBy;
/** @type {SvcMetrics} */
Metrics;
}
export class SvcClerkRow {
/** @param {{EmployeeId?:string,Name?:string,Windows?:SvcNamedTime[],LoadedRate?:number,RateSet?:boolean,RateLocked?:boolean,Metrics?:SvcMetrics}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
EmployeeId;
/** @type {string} */
Name;
/** @type {SvcNamedTime[]} */
Windows = [];
/** @type {?number} */
LoadedRate;
/** @type {boolean} */
RateSet;
/** @type {boolean} */
RateLocked;
/** @type {SvcMetrics} */
Metrics;
}
export class SvcAverage {
/** @param {{Count?:number,Served?:number,AvgServiceSec?:number,MedianServiceSec?:number,AvgWaitSec?:number,Utilization?:number,IdleSec?:number,PausedSec?:number,NoShows?:number,SignedSec?:number,FeesEarned?:number,FeesPerStaffedHour?:number,LaborCost?:number,Contribution?:number,LostNoShowFees?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Count;
/** @type {number} */
Served;
/** @type {?number} */
AvgServiceSec;
/** @type {?number} */
MedianServiceSec;
/** @type {?number} */
AvgWaitSec;
/** @type {?number} */
Utilization;
/** @type {number} */
IdleSec;
/** @type {number} */
PausedSec;
/** @type {number} */
NoShows;
/** @type {number} */
SignedSec;
/** @type {?number} */
FeesEarned;
/** @type {?number} */
FeesPerStaffedHour;
/** @type {?number} */
LaborCost;
/** @type {?number} */
Contribution;
/** @type {?number} */
LostNoShowFees;
}
export class SvcSession {
/** @param {{SessionId?:string,StationId?:string,StationName?:string,EmployeeId?:string,EmployeeName?:string,LocalIn?:string,LocalOut?:string,IsOpen?:boolean,EndReason?:string,PausedSec?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
SessionId;
/** @type {string} */
StationId;
/** @type {string} */
StationName;
/** @type {string} */
EmployeeId;
/** @type {string} */
EmployeeName;
/** @type {string} */
LocalIn;
/** @type {string} */
LocalOut;
/** @type {boolean} */
IsOpen;
/** @type {string} */
EndReason;
/** @type {number} */
PausedSec;
}
export class SvcFeeChange {
/** @param {{LocationId?:string,OnDate?:string,FromFee?:number,ToFee?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
LocationId;
/** @type {string} */
OnDate;
/** @type {number} */
FromFee;
/** @type {number} */
ToFee;
}
export class SvcServiceRow {
/** @param {{LineId?:string,Name?:string,Completed?:number,AvgServiceSec?:number,BranchAvgServiceSec?:number,FeesEarned?:number,FeeCurrent?:number,FeeMin?:number,FeeMax?:number,FeePerMinute?:number,BranchFeePerMinute?:number,FeeChanges?:SvcFeeChange[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
LineId;
/** @type {string} */
Name;
/** @type {number} */
Completed;
/** @type {?number} */
AvgServiceSec;
/** @type {?number} */
BranchAvgServiceSec;
/** @type {?number} */
FeesEarned;
/** @type {?number} */
FeeCurrent;
/** @type {?number} */
FeeMin;
/** @type {?number} */
FeeMax;
/** @type {?number} */
FeePerMinute;
/** @type {?number} */
BranchFeePerMinute;
/** @type {SvcFeeChange[]} */
FeeChanges = [];
}
export class SvcDetail {
/** @param {{Kind?:string,Window?:SvcWindowRow,Clerk?:SvcClerkRow,BranchMetrics?:SvcMetrics,PerRowAverage?:SvcAverage,Sessions?:SvcSession[],Services?:SvcServiceRow[],CanSeeStaff?:boolean,CanSeeFinancial?:boolean,CanSeePay?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Kind;
/** @type {SvcWindowRow} */
Window;
/** @type {SvcClerkRow} */
Clerk;
/** @type {SvcMetrics} */
BranchMetrics;
/** @type {SvcAverage} */
PerRowAverage;
/** @type {SvcSession[]} */
Sessions = [];
/** @type {SvcServiceRow[]} */
Services = [];
/** @type {boolean} */
CanSeeStaff;
/** @type {boolean} */
CanSeeFinancial;
/** @type {boolean} */
CanSeePay;
}
export class KpiV2DetailResponse {
/** @param {{ResponseStatus?:ResponseStatus,Detail?:SvcDetail}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {SvcDetail} */
Detail;
}
export class KpiV2DetailRequest {
/** @param {{BranchId?:string,StationId?:string,EmployeeId?:string,FromDate?:string,ToDate?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
BranchId;
/** @type {?string} */
StationId;
/** @type {?string} */
EmployeeId;
/** @type {string} */
FromDate;
/** @type {string} */
ToDate;
}
JavaScript KpiV2DetailRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
Content-Type: text/jsonl
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: text/jsonl
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}}