| POST,OPTIONS | /v1/dashboard/kpiv2 |
|---|
<?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 DashboardStatTile implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Key=null,
/** @var string|null */
public ?string $Label=null,
/** @var float */
public float $Value=0.0,
/** @var float|null */
public ?float $PreviousValue=null,
/** @var string|null */
public ?string $Unit=null,
/** @var float|null */
public ?float $DeltaPct=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Key'])) $this->Key = $o['Key'];
if (isset($o['Label'])) $this->Label = $o['Label'];
if (isset($o['Value'])) $this->Value = $o['Value'];
if (isset($o['PreviousValue'])) $this->PreviousValue = $o['PreviousValue'];
if (isset($o['Unit'])) $this->Unit = $o['Unit'];
if (isset($o['DeltaPct'])) $this->DeltaPct = $o['DeltaPct'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Key)) $o['Key'] = $this->Key;
if (isset($this->Label)) $o['Label'] = $this->Label;
if (isset($this->Value)) $o['Value'] = $this->Value;
if (isset($this->PreviousValue)) $o['PreviousValue'] = $this->PreviousValue;
if (isset($this->Unit)) $o['Unit'] = $this->Unit;
if (isset($this->DeltaPct)) $o['DeltaPct'] = $this->DeltaPct;
return empty($o) ? new class(){} : $o;
}
}
class DashboardSeriesPoint implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Label=null,
/** @var float */
public float $Value=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Label'])) $this->Label = $o['Label'];
if (isset($o['Value'])) $this->Value = $o['Value'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Label)) $o['Label'] = $this->Label;
if (isset($this->Value)) $o['Value'] = $this->Value;
return empty($o) ? new class(){} : $o;
}
}
class DashboardSeries implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Name=null,
/** @var array<DashboardSeriesPoint>|null */
public ?array $Points=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Points'])) $this->Points = JsonConverters::fromArray('DashboardSeriesPoint', $o['Points']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Points)) $o['Points'] = JsonConverters::toArray('DashboardSeriesPoint', $this->Points);
return empty($o) ? new class(){} : $o;
}
}
class KpiV2LocationRow implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $LocationName=null,
/** @var int */
public int $Walkins=0,
/** @var int */
public int $Completed=0,
/** @var float */
public float $AvgServiceMinutes=0.0,
/** @var float */
public float $AbandonmentPct=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['LocationName'])) $this->LocationName = $o['LocationName'];
if (isset($o['Walkins'])) $this->Walkins = $o['Walkins'];
if (isset($o['Completed'])) $this->Completed = $o['Completed'];
if (isset($o['AvgServiceMinutes'])) $this->AvgServiceMinutes = $o['AvgServiceMinutes'];
if (isset($o['AbandonmentPct'])) $this->AbandonmentPct = $o['AbandonmentPct'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->LocationName)) $o['LocationName'] = $this->LocationName;
if (isset($this->Walkins)) $o['Walkins'] = $this->Walkins;
if (isset($this->Completed)) $o['Completed'] = $this->Completed;
if (isset($this->AvgServiceMinutes)) $o['AvgServiceMinutes'] = $this->AvgServiceMinutes;
if (isset($this->AbandonmentPct)) $o['AbandonmentPct'] = $this->AbandonmentPct;
return empty($o) ? new class(){} : $o;
}
}
class KpiV2WorkerRow implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $WorkerName=null,
/** @var int */
public int $Completed=0,
/** @var float */
public float $AvgServiceMinutes=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['WorkerName'])) $this->WorkerName = $o['WorkerName'];
if (isset($o['Completed'])) $this->Completed = $o['Completed'];
if (isset($o['AvgServiceMinutes'])) $this->AvgServiceMinutes = $o['AvgServiceMinutes'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->WorkerName)) $o['WorkerName'] = $this->WorkerName;
if (isset($this->Completed)) $o['Completed'] = $this->Completed;
if (isset($this->AvgServiceMinutes)) $o['AvgServiceMinutes'] = $this->AvgServiceMinutes;
return empty($o) ? new class(){} : $o;
}
}
class KpiV2HeatPoint implements JsonSerializable
{
public function __construct(
/** @var int */
public int $Dow=0,
/** @var int */
public int $Hr=0,
/** @var int */
public int $Cnt=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Dow'])) $this->Dow = $o['Dow'];
if (isset($o['Hr'])) $this->Hr = $o['Hr'];
if (isset($o['Cnt'])) $this->Cnt = $o['Cnt'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Dow)) $o['Dow'] = $this->Dow;
if (isset($this->Hr)) $o['Hr'] = $this->Hr;
if (isset($this->Cnt)) $o['Cnt'] = $this->Cnt;
return empty($o) ? new class(){} : $o;
}
}
class KpiV2LiveRow implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $LocationName=null,
/** @var int */
public int $Waiting=0,
/** @var int */
public int $InProgress=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['LocationName'])) $this->LocationName = $o['LocationName'];
if (isset($o['Waiting'])) $this->Waiting = $o['Waiting'];
if (isset($o['InProgress'])) $this->InProgress = $o['InProgress'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->LocationName)) $o['LocationName'] = $this->LocationName;
if (isset($this->Waiting)) $o['Waiting'] = $this->Waiting;
if (isset($this->InProgress)) $o['InProgress'] = $this->InProgress;
return empty($o) ? new class(){} : $o;
}
}
class KpiV2Response implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var array<DashboardStatTile>|null */
public ?array $Stats=null,
/** @var array<DashboardSeries>|null */
public ?array $Trend=null,
/** @var DashboardSeries|null */
public ?DashboardSeries $ServicesByType=null,
/** @var array<KpiV2LocationRow>|null */
public ?array $LocationLeaderboard=null,
/** @var array<KpiV2WorkerRow>|null */
public ?array $WorkerProductivity=null,
/** @var array<KpiV2HeatPoint>|null */
public ?array $Heatmap=null,
/** @var array<KpiV2LiveRow>|null */
public ?array $LiveQueue=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['Stats'])) $this->Stats = JsonConverters::fromArray('DashboardStatTile', $o['Stats']);
if (isset($o['Trend'])) $this->Trend = JsonConverters::fromArray('DashboardSeries', $o['Trend']);
if (isset($o['ServicesByType'])) $this->ServicesByType = JsonConverters::from('DashboardSeries', $o['ServicesByType']);
if (isset($o['LocationLeaderboard'])) $this->LocationLeaderboard = JsonConverters::fromArray('KpiV2LocationRow', $o['LocationLeaderboard']);
if (isset($o['WorkerProductivity'])) $this->WorkerProductivity = JsonConverters::fromArray('KpiV2WorkerRow', $o['WorkerProductivity']);
if (isset($o['Heatmap'])) $this->Heatmap = JsonConverters::fromArray('KpiV2HeatPoint', $o['Heatmap']);
if (isset($o['LiveQueue'])) $this->LiveQueue = JsonConverters::fromArray('KpiV2LiveRow', $o['LiveQueue']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->Stats)) $o['Stats'] = JsonConverters::toArray('DashboardStatTile', $this->Stats);
if (isset($this->Trend)) $o['Trend'] = JsonConverters::toArray('DashboardSeries', $this->Trend);
if (isset($this->ServicesByType)) $o['ServicesByType'] = JsonConverters::to('DashboardSeries', $this->ServicesByType);
if (isset($this->LocationLeaderboard)) $o['LocationLeaderboard'] = JsonConverters::toArray('KpiV2LocationRow', $this->LocationLeaderboard);
if (isset($this->WorkerProductivity)) $o['WorkerProductivity'] = JsonConverters::toArray('KpiV2WorkerRow', $this->WorkerProductivity);
if (isset($this->Heatmap)) $o['Heatmap'] = JsonConverters::toArray('KpiV2HeatPoint', $this->Heatmap);
if (isset($this->LiveQueue)) $o['LiveQueue'] = JsonConverters::toArray('KpiV2LiveRow', $this->LiveQueue);
return empty($o) ? new class(){} : $o;
}
}
class KpiV2Request implements JsonSerializable
{
public function __construct(
/** @var DateTime */
public DateTime $FromDate=new DateTime(),
/** @var DateTime */
public DateTime $ToDate=new DateTime(),
/** @var array<string>|null */
public ?array $LocationIds=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['FromDate'])) $this->FromDate = JsonConverters::from('DateTime', $o['FromDate']);
if (isset($o['ToDate'])) $this->ToDate = JsonConverters::from('DateTime', $o['ToDate']);
if (isset($o['LocationIds'])) $this->LocationIds = JsonConverters::fromArray('Guid', $o['LocationIds']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->FromDate)) $o['FromDate'] = JsonConverters::to('DateTime', $this->FromDate);
if (isset($this->ToDate)) $o['ToDate'] = JsonConverters::to('DateTime', $this->ToDate);
if (isset($this->LocationIds)) $o['LocationIds'] = JsonConverters::toArray('Guid', $this->LocationIds);
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/dashboard/kpiv2 HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
FromDate: 0001-01-01,
ToDate: 0001-01-01,
LocationIds:
[
00000000000000000000000000000000
]
}
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
}
},
Stats:
[
{
Key: String,
Label: String,
Value: 0,
PreviousValue: 0,
Unit: String
}
],
Trend:
[
{
Name: String,
Points:
[
{
Label: String,
Value: 0
}
]
}
],
ServicesByType:
{
Name: String,
Points:
[
{
Label: String,
Value: 0
}
]
},
LocationLeaderboard:
[
{
LocationName: String,
Walkins: 0,
Completed: 0,
AvgServiceMinutes: 0,
AbandonmentPct: 0
}
],
WorkerProductivity:
[
{
WorkerName: String,
Completed: 0,
AvgServiceMinutes: 0
}
],
Heatmap:
[
{
Dow: 0,
Hr: 0,
Cnt: 0
}
],
LiveQueue:
[
{
LocationName: String,
Waiting: 0,
InProgress: 0
}
]
}