| POST,OPTIONS | /v1/dashboard/kpiv2/detail |
|---|
export class SvcNamedTime
{
public Id: string;
public Name: string;
public SignedSec: number;
public Served: number;
public constructor(init?: Partial<SvcNamedTime>) { (Object as any).assign(this, init); }
}
export class SvcTint
{
public Field: string;
public Tone: string;
public Reason: string;
public Value?: number;
public Reference?: number;
public BranchValue?: number;
public constructor(init?: Partial<SvcTint>) { (Object as any).assign(this, init); }
}
export class SvcMetrics
{
public Checkins: number;
public Walkins: number;
public Appts: number;
public Served: number;
public NoShows: number;
public ApptNoShows: number;
public CancelledAtWindow: number;
public Abandoned: number;
public Called: number;
public CalledUp: number;
public AbandonRate?: number;
public NoShowRate?: number;
public AvgServiceSec?: number;
public MedianServiceSec?: number;
public AvgWaitSec?: number;
public MaxWaitSec: number;
public AvgWalkUpSec?: number;
public ExpectedServiceSec?: number;
public SignedSec: number;
public ServingSec: number;
public PausedSec: number;
public IdleSec: number;
public UnstaffedSec: number;
public Utilization?: number;
public IdleShare?: number;
public PausedShare?: number;
public Sessions: number;
public OpenDays: number;
public FeesEarned?: number;
public AvgFee?: number;
public FeesPerStaffedHour?: number;
public ExpectedFeesPerStaffedHour?: number;
public LaborCost?: number;
public LaborPartial: boolean;
public MissingCostEmployeeIds: string[] = [];
public MissingCost: SvcNamedTime[] = [];
public LaborLocked: boolean;
public Contribution?: number;
public LostFees?: number;
public LostNoShowFees?: number;
public Mix: { [index:string]: number; } = {};
public HourlyServed: number[] = [];
public HourlyFees: number[] = [];
public HourlyCost: number[] = [];
public Tints: SvcTint[] = [];
public constructor(init?: Partial<SvcMetrics>) { (Object as any).assign(this, init); }
}
export class SvcWindowRow
{
public StationId: string;
public Name: string;
public Clerks: SvcNamedTime[] = [];
public NeverStaffed: boolean;
public LastStaffedUtc?: string;
public LastStaffedBy: string;
public Metrics: SvcMetrics;
public constructor(init?: Partial<SvcWindowRow>) { (Object as any).assign(this, init); }
}
export class SvcClerkRow
{
public EmployeeId: string;
public Name: string;
public Windows: SvcNamedTime[] = [];
public LoadedRate?: number;
public RateSet: boolean;
public RateLocked: boolean;
public Metrics: SvcMetrics;
public constructor(init?: Partial<SvcClerkRow>) { (Object as any).assign(this, init); }
}
export class SvcAverage
{
public Count: number;
public Served: number;
public AvgServiceSec?: number;
public MedianServiceSec?: number;
public AvgWaitSec?: number;
public Utilization?: number;
public IdleSec: number;
public PausedSec: number;
public NoShows: number;
public SignedSec: number;
public FeesEarned?: number;
public FeesPerStaffedHour?: number;
public LaborCost?: number;
public Contribution?: number;
public LostNoShowFees?: number;
public constructor(init?: Partial<SvcAverage>) { (Object as any).assign(this, init); }
}
export class SvcSession
{
public SessionId: string;
public StationId: string;
public StationName: string;
public EmployeeId: string;
public EmployeeName: string;
public LocalIn: string;
public LocalOut: string;
public IsOpen: boolean;
public EndReason: string;
public PausedSec: number;
public constructor(init?: Partial<SvcSession>) { (Object as any).assign(this, init); }
}
export class SvcFeeChange
{
public LocationId: string;
public OnDate: string;
public FromFee: number;
public ToFee: number;
public constructor(init?: Partial<SvcFeeChange>) { (Object as any).assign(this, init); }
}
export class SvcServiceRow
{
public LineId: string;
public Name: string;
public Completed: number;
public AvgServiceSec?: number;
public BranchAvgServiceSec?: number;
public FeesEarned?: number;
public FeeCurrent?: number;
public FeeMin?: number;
public FeeMax?: number;
public FeePerMinute?: number;
public BranchFeePerMinute?: number;
public FeeChanges: SvcFeeChange[] = [];
public constructor(init?: Partial<SvcServiceRow>) { (Object as any).assign(this, init); }
}
export class SvcDetail
{
public Kind: string;
public Window: SvcWindowRow;
public Clerk: SvcClerkRow;
public BranchMetrics: SvcMetrics;
public PerRowAverage: SvcAverage;
public Sessions: SvcSession[] = [];
public Services: SvcServiceRow[] = [];
public CanSeeStaff: boolean;
public CanSeeFinancial: boolean;
public CanSeePay: boolean;
public constructor(init?: Partial<SvcDetail>) { (Object as any).assign(this, init); }
}
export class KpiV2DetailResponse
{
public ResponseStatus: ResponseStatus;
public Detail: SvcDetail;
public constructor(init?: Partial<KpiV2DetailResponse>) { (Object as any).assign(this, init); }
}
export class KpiV2DetailRequest
{
public BranchId: string;
public StationId?: string;
public EmployeeId?: string;
public FromDate: string;
public ToDate: string;
public constructor(init?: Partial<KpiV2DetailRequest>) { (Object as any).assign(this, init); }
}
TypeScript KpiV2DetailRequest DTOs
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/detail HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
BranchId: 00000000000000000000000000000000,
StationId: 00000000000000000000000000000000,
EmployeeId: 00000000000000000000000000000000,
FromDate: 0001-01-01,
ToDate: 0001-01-01
}
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
}
},
Detail:
{
Kind: String,
Window:
{
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
}
]
}
},
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-01,
LocalOut: 0001-01-01,
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-01,
FromFee: 0,
ToFee: 0
}
]
}
],
CanSeeStaff: False,
CanSeeFinancial: False,
CanSeePay: False
}
}