| GET | /v1/workforce/planning |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class OtRow implements JsonSerializable
{
public function __construct(
/** @var int */
public int $ContactID=0,
/** @var string|null */
public ?string $WorkerName=null,
/** @var string|null */
public ?string $ClassCode=null,
/** @var string|null */
public ?string $Crew=null,
/** @var string|null */
public ?string $Job=null,
/** @var string|null */
public ?string $PatternLabel=null,
/** @var float */
public float $ProjHours=0.0,
/** @var float */
public float $OtHours=0.0,
/** @var float */
public float $DtHours=0.0,
/** @var float|null */
public ?float $OtCost=null,
/** @var string|null */
public ?string $State=null,
/** @var string|null */
public ?string $Tone=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ContactID'])) $this->ContactID = $o['ContactID'];
if (isset($o['WorkerName'])) $this->WorkerName = $o['WorkerName'];
if (isset($o['ClassCode'])) $this->ClassCode = $o['ClassCode'];
if (isset($o['Crew'])) $this->Crew = $o['Crew'];
if (isset($o['Job'])) $this->Job = $o['Job'];
if (isset($o['PatternLabel'])) $this->PatternLabel = $o['PatternLabel'];
if (isset($o['ProjHours'])) $this->ProjHours = $o['ProjHours'];
if (isset($o['OtHours'])) $this->OtHours = $o['OtHours'];
if (isset($o['DtHours'])) $this->DtHours = $o['DtHours'];
if (isset($o['OtCost'])) $this->OtCost = $o['OtCost'];
if (isset($o['State'])) $this->State = $o['State'];
if (isset($o['Tone'])) $this->Tone = $o['Tone'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ContactID)) $o['ContactID'] = $this->ContactID;
if (isset($this->WorkerName)) $o['WorkerName'] = $this->WorkerName;
if (isset($this->ClassCode)) $o['ClassCode'] = $this->ClassCode;
if (isset($this->Crew)) $o['Crew'] = $this->Crew;
if (isset($this->Job)) $o['Job'] = $this->Job;
if (isset($this->PatternLabel)) $o['PatternLabel'] = $this->PatternLabel;
if (isset($this->ProjHours)) $o['ProjHours'] = $this->ProjHours;
if (isset($this->OtHours)) $o['OtHours'] = $this->OtHours;
if (isset($this->DtHours)) $o['DtHours'] = $this->DtHours;
if (isset($this->OtCost)) $o['OtCost'] = $this->OtCost;
if (isset($this->State)) $o['State'] = $this->State;
if (isset($this->Tone)) $o['Tone'] = $this->Tone;
return empty($o) ? new class(){} : $o;
}
}
class OtExposureBoard implements JsonSerializable
{
public function __construct(
/** @var float|null */
public ?float $TotalOtCost=null,
/** @var float */
public float $TotalOtHours=0.0,
/** @var int */
public int $OverCount=0,
/** @var int */
public int $WorkerCount=0,
/** @var array<OtRow>|null */
public ?array $Rows=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['TotalOtCost'])) $this->TotalOtCost = $o['TotalOtCost'];
if (isset($o['TotalOtHours'])) $this->TotalOtHours = $o['TotalOtHours'];
if (isset($o['OverCount'])) $this->OverCount = $o['OverCount'];
if (isset($o['WorkerCount'])) $this->WorkerCount = $o['WorkerCount'];
if (isset($o['Rows'])) $this->Rows = JsonConverters::fromArray('OtRow', $o['Rows']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->TotalOtCost)) $o['TotalOtCost'] = $this->TotalOtCost;
if (isset($this->TotalOtHours)) $o['TotalOtHours'] = $this->TotalOtHours;
if (isset($this->OverCount)) $o['OverCount'] = $this->OverCount;
if (isset($this->WorkerCount)) $o['WorkerCount'] = $this->WorkerCount;
if (isset($this->Rows)) $o['Rows'] = JsonConverters::toArray('OtRow', $this->Rows);
return empty($o) ? new class(){} : $o;
}
}
class PerDiemJobRow implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Job=null,
/** @var float */
public float $Total=0.0,
/** @var float */
public float $NonTax=0.0,
/** @var float */
public float $Tax=0.0,
/** @var int */
public int $Days=0,
/** @var int */
public int $AwayCount=0,
/** @var bool|null */
public ?bool $DayRateFlag=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Job'])) $this->Job = $o['Job'];
if (isset($o['Total'])) $this->Total = $o['Total'];
if (isset($o['NonTax'])) $this->NonTax = $o['NonTax'];
if (isset($o['Tax'])) $this->Tax = $o['Tax'];
if (isset($o['Days'])) $this->Days = $o['Days'];
if (isset($o['AwayCount'])) $this->AwayCount = $o['AwayCount'];
if (isset($o['DayRateFlag'])) $this->DayRateFlag = $o['DayRateFlag'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Job)) $o['Job'] = $this->Job;
if (isset($this->Total)) $o['Total'] = $this->Total;
if (isset($this->NonTax)) $o['NonTax'] = $this->NonTax;
if (isset($this->Tax)) $o['Tax'] = $this->Tax;
if (isset($this->Days)) $o['Days'] = $this->Days;
if (isset($this->AwayCount)) $o['AwayCount'] = $this->AwayCount;
if (isset($this->DayRateFlag)) $o['DayRateFlag'] = $this->DayRateFlag;
return empty($o) ? new class(){} : $o;
}
}
class PerDiemBoard implements JsonSerializable
{
public function __construct(
/** @var float */
public float $TotalCost=0.0,
/** @var float */
public float $NonTaxable=0.0,
/** @var float */
public float $Taxable=0.0,
/** @var int */
public int $AwayCount=0,
/** @var array<PerDiemJobRow>|null */
public ?array $Jobs=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['TotalCost'])) $this->TotalCost = $o['TotalCost'];
if (isset($o['NonTaxable'])) $this->NonTaxable = $o['NonTaxable'];
if (isset($o['Taxable'])) $this->Taxable = $o['Taxable'];
if (isset($o['AwayCount'])) $this->AwayCount = $o['AwayCount'];
if (isset($o['Jobs'])) $this->Jobs = JsonConverters::fromArray('PerDiemJobRow', $o['Jobs']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->TotalCost)) $o['TotalCost'] = $this->TotalCost;
if (isset($this->NonTaxable)) $o['NonTaxable'] = $this->NonTaxable;
if (isset($this->Taxable)) $o['Taxable'] = $this->Taxable;
if (isset($this->AwayCount)) $o['AwayCount'] = $this->AwayCount;
if (isset($this->Jobs)) $o['Jobs'] = JsonConverters::toArray('PerDiemJobRow', $this->Jobs);
return empty($o) ? new class(){} : $o;
}
}
class MarginJobRow implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Job=null,
/** @var float */
public float $BasePct=0.0,
/** @var float */
public float $ProjPct=0.0,
/** @var float */
public float $FadePts=0.0,
/** @var string|null */
public ?string $Severity=null,
/** @var float|null */
public ?float $OtCost=null,
/** @var float */
public float $PerDiem=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Job'])) $this->Job = $o['Job'];
if (isset($o['BasePct'])) $this->BasePct = $o['BasePct'];
if (isset($o['ProjPct'])) $this->ProjPct = $o['ProjPct'];
if (isset($o['FadePts'])) $this->FadePts = $o['FadePts'];
if (isset($o['Severity'])) $this->Severity = $o['Severity'];
if (isset($o['OtCost'])) $this->OtCost = $o['OtCost'];
if (isset($o['PerDiem'])) $this->PerDiem = $o['PerDiem'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Job)) $o['Job'] = $this->Job;
if (isset($this->BasePct)) $o['BasePct'] = $this->BasePct;
if (isset($this->ProjPct)) $o['ProjPct'] = $this->ProjPct;
if (isset($this->FadePts)) $o['FadePts'] = $this->FadePts;
if (isset($this->Severity)) $o['Severity'] = $this->Severity;
if (isset($this->OtCost)) $o['OtCost'] = $this->OtCost;
if (isset($this->PerDiem)) $o['PerDiem'] = $this->PerDiem;
return empty($o) ? new class(){} : $o;
}
}
class MarginBoard implements JsonSerializable
{
public function __construct(
/** @var int */
public int $JobCount=0,
/** @var float|null */
public ?float $TotalFade=null,
/** @var array<MarginJobRow>|null */
public ?array $Jobs=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['JobCount'])) $this->JobCount = $o['JobCount'];
if (isset($o['TotalFade'])) $this->TotalFade = $o['TotalFade'];
if (isset($o['Jobs'])) $this->Jobs = JsonConverters::fromArray('MarginJobRow', $o['Jobs']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->JobCount)) $o['JobCount'] = $this->JobCount;
if (isset($this->TotalFade)) $o['TotalFade'] = $this->TotalFade;
if (isset($this->Jobs)) $o['Jobs'] = JsonConverters::toArray('MarginJobRow', $this->Jobs);
return empty($o) ? new class(){} : $o;
}
}
class UtilRow implements JsonSerializable
{
public function __construct(
/** @var int */
public int $ContactID=0,
/** @var string|null */
public ?string $WorkerName=null,
/** @var string|null */
public ?string $Crew=null,
/** @var float */
public float $ProjHours=0.0,
/** @var float */
public float $BaselineHours=0.0,
/** @var float */
public float $Pct=0.0,
/** @var string|null */
public ?string $Band=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ContactID'])) $this->ContactID = $o['ContactID'];
if (isset($o['WorkerName'])) $this->WorkerName = $o['WorkerName'];
if (isset($o['Crew'])) $this->Crew = $o['Crew'];
if (isset($o['ProjHours'])) $this->ProjHours = $o['ProjHours'];
if (isset($o['BaselineHours'])) $this->BaselineHours = $o['BaselineHours'];
if (isset($o['Pct'])) $this->Pct = $o['Pct'];
if (isset($o['Band'])) $this->Band = $o['Band'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ContactID)) $o['ContactID'] = $this->ContactID;
if (isset($this->WorkerName)) $o['WorkerName'] = $this->WorkerName;
if (isset($this->Crew)) $o['Crew'] = $this->Crew;
if (isset($this->ProjHours)) $o['ProjHours'] = $this->ProjHours;
if (isset($this->BaselineHours)) $o['BaselineHours'] = $this->BaselineHours;
if (isset($this->Pct)) $o['Pct'] = $this->Pct;
if (isset($this->Band)) $o['Band'] = $this->Band;
return empty($o) ? new class(){} : $o;
}
}
class UtilizationBoard implements JsonSerializable
{
public function __construct(
/** @var int */
public int $UnderCount=0,
/** @var int */
public int $OverCount=0,
/** @var array<UtilRow>|null */
public ?array $Rows=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['UnderCount'])) $this->UnderCount = $o['UnderCount'];
if (isset($o['OverCount'])) $this->OverCount = $o['OverCount'];
if (isset($o['Rows'])) $this->Rows = JsonConverters::fromArray('UtilRow', $o['Rows']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->UnderCount)) $o['UnderCount'] = $this->UnderCount;
if (isset($this->OverCount)) $o['OverCount'] = $this->OverCount;
if (isset($this->Rows)) $o['Rows'] = JsonConverters::toArray('UtilRow', $this->Rows);
return empty($o) ? new class(){} : $o;
}
}
class PlanningSuggestion implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Id=null,
/** @var string|null */
public ?string $Kind=null,
/** @var string|null */
public ?string $Title=null,
/** @var string|null */
public ?string $Detail=null,
/** @var string|null */
public ?string $SaveText=null,
/** @var string|null */
public ?string $Effect=null,
/** @var string|null */
public ?string $RuleId=null,
/** @var string|null */
public ?string $LegalNote=null,
/** @var string|null */
public ?string $ApplyLabel=null,
/** @var string|null */
public ?string $Severity=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Kind'])) $this->Kind = $o['Kind'];
if (isset($o['Title'])) $this->Title = $o['Title'];
if (isset($o['Detail'])) $this->Detail = $o['Detail'];
if (isset($o['SaveText'])) $this->SaveText = $o['SaveText'];
if (isset($o['Effect'])) $this->Effect = $o['Effect'];
if (isset($o['RuleId'])) $this->RuleId = $o['RuleId'];
if (isset($o['LegalNote'])) $this->LegalNote = $o['LegalNote'];
if (isset($o['ApplyLabel'])) $this->ApplyLabel = $o['ApplyLabel'];
if (isset($o['Severity'])) $this->Severity = $o['Severity'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Kind)) $o['Kind'] = $this->Kind;
if (isset($this->Title)) $o['Title'] = $this->Title;
if (isset($this->Detail)) $o['Detail'] = $this->Detail;
if (isset($this->SaveText)) $o['SaveText'] = $this->SaveText;
if (isset($this->Effect)) $o['Effect'] = $this->Effect;
if (isset($this->RuleId)) $o['RuleId'] = $this->RuleId;
if (isset($this->LegalNote)) $o['LegalNote'] = $this->LegalNote;
if (isset($this->ApplyLabel)) $o['ApplyLabel'] = $this->ApplyLabel;
if (isset($this->Severity)) $o['Severity'] = $this->Severity;
return empty($o) ? new class(){} : $o;
}
}
class PlanningSurface implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $WeekLabel=null,
/** @var DateTime */
public DateTime $WeekStart=new DateTime(),
/** @var int */
public int $WorkerCount=0,
/** @var OtExposureBoard|null */
public ?OtExposureBoard $Ot=null,
/** @var PerDiemBoard|null */
public ?PerDiemBoard $PerDiem=null,
/** @var MarginBoard|null */
public ?MarginBoard $Margin=null,
/** @var UtilizationBoard|null */
public ?UtilizationBoard $Utilization=null,
/** @var array<PlanningSuggestion>|null */
public ?array $Suggestions=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['WeekLabel'])) $this->WeekLabel = $o['WeekLabel'];
if (isset($o['WeekStart'])) $this->WeekStart = JsonConverters::from('DateTime', $o['WeekStart']);
if (isset($o['WorkerCount'])) $this->WorkerCount = $o['WorkerCount'];
if (isset($o['Ot'])) $this->Ot = JsonConverters::from('OtExposureBoard', $o['Ot']);
if (isset($o['PerDiem'])) $this->PerDiem = JsonConverters::from('PerDiemBoard', $o['PerDiem']);
if (isset($o['Margin'])) $this->Margin = JsonConverters::from('MarginBoard', $o['Margin']);
if (isset($o['Utilization'])) $this->Utilization = JsonConverters::from('UtilizationBoard', $o['Utilization']);
if (isset($o['Suggestions'])) $this->Suggestions = JsonConverters::fromArray('PlanningSuggestion', $o['Suggestions']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->WeekLabel)) $o['WeekLabel'] = $this->WeekLabel;
if (isset($this->WeekStart)) $o['WeekStart'] = JsonConverters::to('DateTime', $this->WeekStart);
if (isset($this->WorkerCount)) $o['WorkerCount'] = $this->WorkerCount;
if (isset($this->Ot)) $o['Ot'] = JsonConverters::to('OtExposureBoard', $this->Ot);
if (isset($this->PerDiem)) $o['PerDiem'] = JsonConverters::to('PerDiemBoard', $this->PerDiem);
if (isset($this->Margin)) $o['Margin'] = JsonConverters::to('MarginBoard', $this->Margin);
if (isset($this->Utilization)) $o['Utilization'] = JsonConverters::to('UtilizationBoard', $this->Utilization);
if (isset($this->Suggestions)) $o['Suggestions'] = JsonConverters::toArray('PlanningSuggestion', $this->Suggestions);
return empty($o) ? new class(){} : $o;
}
}
class PlanningResponse implements JsonSerializable
{
public function __construct(
/** @var PlanningSurface|null */
public ?PlanningSurface $Surface=null,
/** @var bool|null */
public ?bool $CanSeePay=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Surface'])) $this->Surface = JsonConverters::from('PlanningSurface', $o['Surface']);
if (isset($o['CanSeePay'])) $this->CanSeePay = $o['CanSeePay'];
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Surface)) $o['Surface'] = JsonConverters::to('PlanningSurface', $this->Surface);
if (isset($this->CanSeePay)) $o['CanSeePay'] = $this->CanSeePay;
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
class PlanningRequest implements JsonSerializable
{
public function __construct(
/** @var DateTime|null */
public ?DateTime $AsOf=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['AsOf'])) $this->AsOf = JsonConverters::from('DateTime', $o['AsOf']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->AsOf)) $o['AsOf'] = JsonConverters::to('DateTime', $this->AsOf);
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}