| GET | /v1/workforce/planning |
|---|
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 OtRow:
contact_i_d: int = 0
worker_name: Optional[str] = None
class_code: Optional[str] = None
crew: Optional[str] = None
job: Optional[str] = None
pattern_label: Optional[str] = None
proj_hours: Decimal = decimal.Decimal(0)
ot_hours: Decimal = decimal.Decimal(0)
dt_hours: Decimal = decimal.Decimal(0)
ot_cost: Optional[Decimal] = None
state: Optional[str] = None
tone: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OtExposureBoard:
total_ot_cost: Optional[Decimal] = None
total_ot_hours: Decimal = decimal.Decimal(0)
over_count: int = 0
worker_count: int = 0
rows: List[OtRow] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PerDiemJobRow:
job: Optional[str] = None
total: Decimal = decimal.Decimal(0)
non_tax: Decimal = decimal.Decimal(0)
tax: Decimal = decimal.Decimal(0)
days: int = 0
away_count: int = 0
day_rate_flag: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PerDiemBoard:
total_cost: Decimal = decimal.Decimal(0)
non_taxable: Decimal = decimal.Decimal(0)
taxable: Decimal = decimal.Decimal(0)
away_count: int = 0
jobs: List[PerDiemJobRow] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MarginJobRow:
job: Optional[str] = None
base_pct: Decimal = decimal.Decimal(0)
proj_pct: Decimal = decimal.Decimal(0)
fade_pts: Decimal = decimal.Decimal(0)
severity: Optional[str] = None
ot_cost: Optional[Decimal] = None
per_diem: Decimal = decimal.Decimal(0)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MarginBoard:
job_count: int = 0
total_fade: Optional[Decimal] = None
jobs: List[MarginJobRow] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UtilRow:
contact_i_d: int = 0
worker_name: Optional[str] = None
crew: Optional[str] = None
proj_hours: Decimal = decimal.Decimal(0)
baseline_hours: Decimal = decimal.Decimal(0)
pct: Decimal = decimal.Decimal(0)
band: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UtilizationBoard:
under_count: int = 0
over_count: int = 0
rows: List[UtilRow] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PlanningSuggestion:
id: Optional[str] = None
kind: Optional[str] = None
title: Optional[str] = None
detail: Optional[str] = None
save_text: Optional[str] = None
effect: Optional[str] = None
rule_id: Optional[str] = None
legal_note: Optional[str] = None
apply_label: Optional[str] = None
severity: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PlanningSurface:
week_label: Optional[str] = None
week_start: datetime.datetime = datetime.datetime(1, 1, 1)
worker_count: int = 0
ot: Optional[OtExposureBoard] = None
per_diem: Optional[PerDiemBoard] = None
margin: Optional[MarginBoard] = None
utilization: Optional[UtilizationBoard] = None
suggestions: List[PlanningSuggestion] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PlanningResponse:
surface: Optional[PlanningSurface] = None
can_see_pay: bool = False
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PlanningRequest:
as_of: Optional[datetime.datetime] = None
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/workforce/planning HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Surface":{"WeekLabel":"String","WeekStart":"0001-01-01T00:00:00.0000000","WorkerCount":0,"Ot":{"TotalOtCost":0,"TotalOtHours":0,"OverCount":0,"WorkerCount":0,"Rows":[{"ContactID":0,"WorkerName":"String","ClassCode":"String","Crew":"String","Job":"String","PatternLabel":"String","ProjHours":0,"OtHours":0,"DtHours":0,"OtCost":0,"State":"String","Tone":"String"}]},"PerDiem":{"TotalCost":0,"NonTaxable":0,"Taxable":0,"AwayCount":0,"Jobs":[{"Job":"String","Total":0,"NonTax":0,"Tax":0,"Days":0,"AwayCount":0,"DayRateFlag":false}]},"Margin":{"JobCount":0,"TotalFade":0,"Jobs":[{"Job":"String","BasePct":0,"ProjPct":0,"FadePts":0,"Severity":"String","OtCost":0,"PerDiem":0}]},"Utilization":{"UnderCount":0,"OverCount":0,"Rows":[{"ContactID":0,"WorkerName":"String","Crew":"String","ProjHours":0,"BaselineHours":0,"Pct":0,"Band":"String"}]},"Suggestions":[{"Id":"String","Kind":"String","Title":"String","Detail":"String","SaveText":"String","Effect":"String","RuleId":"String","LegalNote":"String","ApplyLabel":"String","Severity":"String"}]},"CanSeePay":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}