| POST | /v1/workforce/calc |
|---|
<?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 CostLine implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Label=null,
/** @var string|null */
public ?string $Detail=null,
/** @var float */
public float $Amount=0.0,
/** @var string|null */
public ?string $RuleId=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Label'])) $this->Label = $o['Label'];
if (isset($o['Detail'])) $this->Detail = $o['Detail'];
if (isset($o['Amount'])) $this->Amount = $o['Amount'];
if (isset($o['RuleId'])) $this->RuleId = $o['RuleId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Label)) $o['Label'] = $this->Label;
if (isset($this->Detail)) $o['Detail'] = $this->Detail;
if (isset($this->Amount)) $o['Amount'] = $this->Amount;
if (isset($this->RuleId)) $o['RuleId'] = $this->RuleId;
return empty($o) ? new class(){} : $o;
}
}
class CostBreakdown implements JsonSerializable
{
public function __construct(
/** @var float */
public float $Rrop=0.0,
/** @var float */
public float $St=0.0,
/** @var float */
public float $Ot=0.0,
/** @var float */
public float $Dt=0.0,
/** @var float */
public float $TotalHours=0.0,
/** @var float */
public float $Straight=0.0,
/** @var float */
public float $DiffPay=0.0,
/** @var float */
public float $OtPremium=0.0,
/** @var float */
public float $DtPremium=0.0,
/** @var float */
public float $CashWages=0.0,
/** @var float */
public float $FringeCashPay=0.0,
/** @var float */
public float $FringePlanPay=0.0,
/** @var float */
public float $BurdenPct=0.0,
/** @var float */
public float $BurdenAmount=0.0,
/** @var bool|null */
public ?bool $PerDiemApplies=null,
/** @var float */
public float $PerDiemCost=0.0,
/** @var float */
public float $PerDiemTaxable=0.0,
/** @var float */
public float $PerDiemNonTax=0.0,
/** @var float */
public float $Loaded=0.0,
/** @var float */
public float $Revenue=0.0,
/** @var float */
public float $Margin=0.0,
/** @var float */
public float $MarginPct=0.0,
/** @var float */
public float $OtMultiplier=0.0,
/** @var float */
public float $DtMultiplier=0.0,
/** @var float */
public float $PerDiemDaily=0.0,
/** @var array<CostLine>|null */
public ?array $Lines=null,
/** @var array<string>|null */
public ?array $Notes=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Rrop'])) $this->Rrop = $o['Rrop'];
if (isset($o['St'])) $this->St = $o['St'];
if (isset($o['Ot'])) $this->Ot = $o['Ot'];
if (isset($o['Dt'])) $this->Dt = $o['Dt'];
if (isset($o['TotalHours'])) $this->TotalHours = $o['TotalHours'];
if (isset($o['Straight'])) $this->Straight = $o['Straight'];
if (isset($o['DiffPay'])) $this->DiffPay = $o['DiffPay'];
if (isset($o['OtPremium'])) $this->OtPremium = $o['OtPremium'];
if (isset($o['DtPremium'])) $this->DtPremium = $o['DtPremium'];
if (isset($o['CashWages'])) $this->CashWages = $o['CashWages'];
if (isset($o['FringeCashPay'])) $this->FringeCashPay = $o['FringeCashPay'];
if (isset($o['FringePlanPay'])) $this->FringePlanPay = $o['FringePlanPay'];
if (isset($o['BurdenPct'])) $this->BurdenPct = $o['BurdenPct'];
if (isset($o['BurdenAmount'])) $this->BurdenAmount = $o['BurdenAmount'];
if (isset($o['PerDiemApplies'])) $this->PerDiemApplies = $o['PerDiemApplies'];
if (isset($o['PerDiemCost'])) $this->PerDiemCost = $o['PerDiemCost'];
if (isset($o['PerDiemTaxable'])) $this->PerDiemTaxable = $o['PerDiemTaxable'];
if (isset($o['PerDiemNonTax'])) $this->PerDiemNonTax = $o['PerDiemNonTax'];
if (isset($o['Loaded'])) $this->Loaded = $o['Loaded'];
if (isset($o['Revenue'])) $this->Revenue = $o['Revenue'];
if (isset($o['Margin'])) $this->Margin = $o['Margin'];
if (isset($o['MarginPct'])) $this->MarginPct = $o['MarginPct'];
if (isset($o['OtMultiplier'])) $this->OtMultiplier = $o['OtMultiplier'];
if (isset($o['DtMultiplier'])) $this->DtMultiplier = $o['DtMultiplier'];
if (isset($o['PerDiemDaily'])) $this->PerDiemDaily = $o['PerDiemDaily'];
if (isset($o['Lines'])) $this->Lines = JsonConverters::fromArray('CostLine', $o['Lines']);
if (isset($o['Notes'])) $this->Notes = JsonConverters::fromArray('string', $o['Notes']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Rrop)) $o['Rrop'] = $this->Rrop;
if (isset($this->St)) $o['St'] = $this->St;
if (isset($this->Ot)) $o['Ot'] = $this->Ot;
if (isset($this->Dt)) $o['Dt'] = $this->Dt;
if (isset($this->TotalHours)) $o['TotalHours'] = $this->TotalHours;
if (isset($this->Straight)) $o['Straight'] = $this->Straight;
if (isset($this->DiffPay)) $o['DiffPay'] = $this->DiffPay;
if (isset($this->OtPremium)) $o['OtPremium'] = $this->OtPremium;
if (isset($this->DtPremium)) $o['DtPremium'] = $this->DtPremium;
if (isset($this->CashWages)) $o['CashWages'] = $this->CashWages;
if (isset($this->FringeCashPay)) $o['FringeCashPay'] = $this->FringeCashPay;
if (isset($this->FringePlanPay)) $o['FringePlanPay'] = $this->FringePlanPay;
if (isset($this->BurdenPct)) $o['BurdenPct'] = $this->BurdenPct;
if (isset($this->BurdenAmount)) $o['BurdenAmount'] = $this->BurdenAmount;
if (isset($this->PerDiemApplies)) $o['PerDiemApplies'] = $this->PerDiemApplies;
if (isset($this->PerDiemCost)) $o['PerDiemCost'] = $this->PerDiemCost;
if (isset($this->PerDiemTaxable)) $o['PerDiemTaxable'] = $this->PerDiemTaxable;
if (isset($this->PerDiemNonTax)) $o['PerDiemNonTax'] = $this->PerDiemNonTax;
if (isset($this->Loaded)) $o['Loaded'] = $this->Loaded;
if (isset($this->Revenue)) $o['Revenue'] = $this->Revenue;
if (isset($this->Margin)) $o['Margin'] = $this->Margin;
if (isset($this->MarginPct)) $o['MarginPct'] = $this->MarginPct;
if (isset($this->OtMultiplier)) $o['OtMultiplier'] = $this->OtMultiplier;
if (isset($this->DtMultiplier)) $o['DtMultiplier'] = $this->DtMultiplier;
if (isset($this->PerDiemDaily)) $o['PerDiemDaily'] = $this->PerDiemDaily;
if (isset($this->Lines)) $o['Lines'] = JsonConverters::toArray('CostLine', $this->Lines);
if (isset($this->Notes)) $o['Notes'] = JsonConverters::toArray('string', $this->Notes);
return empty($o) ? new class(){} : $o;
}
}
class CostInput implements JsonSerializable
{
public function __construct(
/** @var float */
public float $Base=0.0,
/** @var float */
public float $BillRate=0.0,
/** @var float */
public float $FringeCash=0.0,
/** @var float */
public float $FringePlan=0.0,
/** @var bool|null */
public ?bool $IsNight=null,
/** @var float */
public float $HoursPerDay=0.0,
/** @var int */
public int $OnDays=0,
/** @var float|null */
public ?float $OnDaysExact=null,
/** @var bool|null */
public ?bool $HasTravel=null,
/** @var bool|null */
public ?bool $PerDiemEligible=null,
/** @var bool|null */
public ?bool $PrevailingWage=null,
/** @var string|null */
public ?string $Jurisdiction=null,
/** @var string|null */
public ?string $Unit=null,
/** @var float */
public float $PriorHours=0.0,
/** @var string|null */
public ?string $BurdenClass=null,
/** @var float|null */
public ?float $WcRateOverride=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Base'])) $this->Base = $o['Base'];
if (isset($o['BillRate'])) $this->BillRate = $o['BillRate'];
if (isset($o['FringeCash'])) $this->FringeCash = $o['FringeCash'];
if (isset($o['FringePlan'])) $this->FringePlan = $o['FringePlan'];
if (isset($o['IsNight'])) $this->IsNight = $o['IsNight'];
if (isset($o['HoursPerDay'])) $this->HoursPerDay = $o['HoursPerDay'];
if (isset($o['OnDays'])) $this->OnDays = $o['OnDays'];
if (isset($o['OnDaysExact'])) $this->OnDaysExact = $o['OnDaysExact'];
if (isset($o['HasTravel'])) $this->HasTravel = $o['HasTravel'];
if (isset($o['PerDiemEligible'])) $this->PerDiemEligible = $o['PerDiemEligible'];
if (isset($o['PrevailingWage'])) $this->PrevailingWage = $o['PrevailingWage'];
if (isset($o['Jurisdiction'])) $this->Jurisdiction = $o['Jurisdiction'];
if (isset($o['Unit'])) $this->Unit = $o['Unit'];
if (isset($o['PriorHours'])) $this->PriorHours = $o['PriorHours'];
if (isset($o['BurdenClass'])) $this->BurdenClass = $o['BurdenClass'];
if (isset($o['WcRateOverride'])) $this->WcRateOverride = $o['WcRateOverride'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Base)) $o['Base'] = $this->Base;
if (isset($this->BillRate)) $o['BillRate'] = $this->BillRate;
if (isset($this->FringeCash)) $o['FringeCash'] = $this->FringeCash;
if (isset($this->FringePlan)) $o['FringePlan'] = $this->FringePlan;
if (isset($this->IsNight)) $o['IsNight'] = $this->IsNight;
if (isset($this->HoursPerDay)) $o['HoursPerDay'] = $this->HoursPerDay;
if (isset($this->OnDays)) $o['OnDays'] = $this->OnDays;
if (isset($this->OnDaysExact)) $o['OnDaysExact'] = $this->OnDaysExact;
if (isset($this->HasTravel)) $o['HasTravel'] = $this->HasTravel;
if (isset($this->PerDiemEligible)) $o['PerDiemEligible'] = $this->PerDiemEligible;
if (isset($this->PrevailingWage)) $o['PrevailingWage'] = $this->PrevailingWage;
if (isset($this->Jurisdiction)) $o['Jurisdiction'] = $this->Jurisdiction;
if (isset($this->Unit)) $o['Unit'] = $this->Unit;
if (isset($this->PriorHours)) $o['PriorHours'] = $this->PriorHours;
if (isset($this->BurdenClass)) $o['BurdenClass'] = $this->BurdenClass;
if (isset($this->WcRateOverride)) $o['WcRateOverride'] = $this->WcRateOverride;
return empty($o) ? new class(){} : $o;
}
}
class CostCalcResponse implements JsonSerializable
{
public function __construct(
/** @var CostBreakdown|null */
public ?CostBreakdown $Result=null,
/** @var CostInput|null */
public ?CostInput $ResolvedInput=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['Result'])) $this->Result = JsonConverters::from('CostBreakdown', $o['Result']);
if (isset($o['ResolvedInput'])) $this->ResolvedInput = JsonConverters::from('CostInput', $o['ResolvedInput']);
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->Result)) $o['Result'] = JsonConverters::to('CostBreakdown', $this->Result);
if (isset($this->ResolvedInput)) $o['ResolvedInput'] = JsonConverters::to('CostInput', $this->ResolvedInput);
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 CostCalcRequest implements JsonSerializable
{
public function __construct(
/** @var CostInput|null */
public ?CostInput $Input=null,
/** @var int|null */
public ?int $ContactID=null,
/** @var int|null */
public ?int $ProjectID=null,
/** @var int|null */
public ?int $ShiftPatternID=null,
/** @var string|null */
public ?string $Unit=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Input'])) $this->Input = JsonConverters::from('CostInput', $o['Input']);
if (isset($o['ContactID'])) $this->ContactID = $o['ContactID'];
if (isset($o['ProjectID'])) $this->ProjectID = $o['ProjectID'];
if (isset($o['ShiftPatternID'])) $this->ShiftPatternID = $o['ShiftPatternID'];
if (isset($o['Unit'])) $this->Unit = $o['Unit'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Input)) $o['Input'] = JsonConverters::to('CostInput', $this->Input);
if (isset($this->ContactID)) $o['ContactID'] = $this->ContactID;
if (isset($this->ProjectID)) $o['ProjectID'] = $this->ProjectID;
if (isset($this->ShiftPatternID)) $o['ShiftPatternID'] = $this->ShiftPatternID;
if (isset($this->Unit)) $o['Unit'] = $this->Unit;
return empty($o) ? new class(){} : $o;
}
}
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/workforce/calc HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Input:
{
Base: 0,
BillRate: 0,
FringeCash: 0,
FringePlan: 0,
IsNight: False,
HoursPerDay: 0,
OnDays: 0,
OnDaysExact: 0,
HasTravel: False,
PerDiemEligible: False,
PrevailingWage: False,
Jurisdiction: String,
Unit: String,
PriorHours: 0,
BurdenClass: String,
WcRateOverride: 0
},
ContactID: 0,
ProjectID: 0,
ShiftPatternID: 0,
Unit: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Result:
{
Rrop: 0,
St: 0,
Ot: 0,
Dt: 0,
TotalHours: 0,
Straight: 0,
DiffPay: 0,
OtPremium: 0,
DtPremium: 0,
CashWages: 0,
FringeCashPay: 0,
FringePlanPay: 0,
BurdenPct: 0,
BurdenAmount: 0,
PerDiemApplies: False,
PerDiemCost: 0,
PerDiemTaxable: 0,
PerDiemNonTax: 0,
Loaded: 0,
Revenue: 0,
Margin: 0,
MarginPct: 0,
OtMultiplier: 0,
DtMultiplier: 0,
PerDiemDaily: 0,
Lines:
[
{
Label: String,
Detail: String,
Amount: 0,
RuleId: String
}
],
Notes:
[
String
]
},
ResolvedInput:
{
Base: 0,
BillRate: 0,
FringeCash: 0,
FringePlan: 0,
IsNight: False,
HoursPerDay: 0,
OnDays: 0,
OnDaysExact: 0,
HasTravel: False,
PerDiemEligible: False,
PrevailingWage: False,
Jurisdiction: String,
Unit: String,
PriorHours: 0,
BurdenClass: String,
WcRateOverride: 0
},
CanSeePay: False,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}