| POST,OPTIONS | /v1/dashboard/kpiv2/detail |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcNamedTime:
id: Optional[str] = None
name: Optional[str] = None
signed_sec: int = 0
served: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcTint:
field: Optional[str] = None
tone: Optional[str] = None
reason: Optional[str] = None
value: Optional[float] = None
reference: Optional[float] = None
branch_value: Optional[float] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcMetrics:
checkins: int = 0
walkins: int = 0
appts: int = 0
served: int = 0
no_shows: int = 0
appt_no_shows: int = 0
cancelled_at_window: int = 0
abandoned: int = 0
called: int = 0
called_up: int = 0
abandon_rate: Optional[float] = None
no_show_rate: Optional[float] = None
avg_service_sec: Optional[float] = None
median_service_sec: Optional[float] = None
avg_wait_sec: Optional[float] = None
max_wait_sec: int = 0
avg_walk_up_sec: Optional[float] = None
expected_service_sec: Optional[float] = None
signed_sec: int = 0
serving_sec: int = 0
paused_sec: int = 0
idle_sec: int = 0
unstaffed_sec: int = 0
utilization: Optional[float] = None
idle_share: Optional[float] = None
paused_share: Optional[float] = None
sessions: int = 0
open_days: int = 0
fees_earned: Optional[Decimal] = None
avg_fee: Optional[Decimal] = None
fees_per_staffed_hour: Optional[Decimal] = None
expected_fees_per_staffed_hour: Optional[Decimal] = None
labor_cost: Optional[Decimal] = None
labor_partial: bool = False
missing_cost_employee_ids: List[str] = field(default_factory=list)
missing_cost: List[SvcNamedTime] = field(default_factory=list)
labor_locked: bool = False
contribution: Optional[Decimal] = None
lost_fees: Optional[Decimal] = None
lost_no_show_fees: Optional[Decimal] = None
mix: Dict[str, int] = field(default_factory=dict)
hourly_served: List[int] = field(default_factory=list)
hourly_fees: List[Decimal] = field(default_factory=list)
hourly_cost: List[Decimal] = field(default_factory=list)
tints: List[SvcTint] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcWindowRow:
station_id: Optional[str] = None
name: Optional[str] = None
clerks: List[SvcNamedTime] = field(default_factory=list)
never_staffed: bool = False
last_staffed_utc: Optional[datetime.datetime] = None
last_staffed_by: Optional[str] = None
metrics: Optional[SvcMetrics] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcClerkRow:
employee_id: Optional[str] = None
name: Optional[str] = None
windows: List[SvcNamedTime] = field(default_factory=list)
loaded_rate: Optional[Decimal] = None
rate_set: bool = False
rate_locked: bool = False
metrics: Optional[SvcMetrics] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcAverage:
count: int = 0
served: float = 0.0
avg_service_sec: Optional[float] = None
median_service_sec: Optional[float] = None
avg_wait_sec: Optional[float] = None
utilization: Optional[float] = None
idle_sec: float = 0.0
paused_sec: float = 0.0
no_shows: float = 0.0
signed_sec: float = 0.0
fees_earned: Optional[Decimal] = None
fees_per_staffed_hour: Optional[Decimal] = None
labor_cost: Optional[Decimal] = None
contribution: Optional[Decimal] = None
lost_no_show_fees: Optional[Decimal] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcSession:
session_id: Optional[str] = None
station_id: Optional[str] = None
station_name: Optional[str] = None
employee_id: Optional[str] = None
employee_name: Optional[str] = None
local_in: datetime.datetime = datetime.datetime(1, 1, 1)
local_out: datetime.datetime = datetime.datetime(1, 1, 1)
is_open: bool = False
end_reason: Optional[str] = None
paused_sec: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcFeeChange:
location_id: Optional[str] = None
on_date: datetime.datetime = datetime.datetime(1, 1, 1)
from_fee: Decimal = decimal.Decimal(0)
to_fee: Decimal = decimal.Decimal(0)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcServiceRow:
line_id: Optional[str] = None
name: Optional[str] = None
completed: int = 0
avg_service_sec: Optional[float] = None
branch_avg_service_sec: Optional[float] = None
fees_earned: Optional[Decimal] = None
fee_current: Optional[Decimal] = None
fee_min: Optional[Decimal] = None
fee_max: Optional[Decimal] = None
fee_per_minute: Optional[Decimal] = None
branch_fee_per_minute: Optional[Decimal] = None
fee_changes: List[SvcFeeChange] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcDetail:
kind: Optional[str] = None
window: Optional[SvcWindowRow] = None
clerk: Optional[SvcClerkRow] = None
branch_metrics: Optional[SvcMetrics] = None
per_row_average: Optional[SvcAverage] = None
sessions: List[SvcSession] = field(default_factory=list)
services: List[SvcServiceRow] = field(default_factory=list)
can_see_staff: bool = False
can_see_financial: bool = False
can_see_pay: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class KpiV2DetailResponse:
response_status: Optional[ResponseStatus] = None
detail: Optional[SvcDetail] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class KpiV2DetailRequest:
branch_id: Optional[str] = None
station_id: Optional[str] = None
employee_id: Optional[str] = None
from_date: datetime.datetime = datetime.datetime(1, 1, 1)
to_date: datetime.datetime = datetime.datetime(1, 1, 1)
Python 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
}
}