| GET | /api/dashboards |
|---|
<?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 TileDto implements JsonSerializable
{
public function __construct(
/** @var string */
public string $ID='',
/** @var string */
public string $GroupID='',
/** @var int */
public int $Type=0,
/** @var string|null */
public ?string $Name=null,
/** @var int */
public int $Order=0,
/** @var int */
public int $Cols=0,
/** @var int */
public int $Rows=0,
/** @var int */
public int $Style=0,
/** @var string|null */
public ?string $Data=null,
/** @var string|null */
public ?string $FontAwesomeIcon=null,
/** @var string|null */
public ?string $FontAwesomeStyle=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ID'])) $this->ID = $o['ID'];
if (isset($o['GroupID'])) $this->GroupID = $o['GroupID'];
if (isset($o['Type'])) $this->Type = $o['Type'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Order'])) $this->Order = $o['Order'];
if (isset($o['Cols'])) $this->Cols = $o['Cols'];
if (isset($o['Rows'])) $this->Rows = $o['Rows'];
if (isset($o['Style'])) $this->Style = $o['Style'];
if (isset($o['Data'])) $this->Data = $o['Data'];
if (isset($o['FontAwesomeIcon'])) $this->FontAwesomeIcon = $o['FontAwesomeIcon'];
if (isset($o['FontAwesomeStyle'])) $this->FontAwesomeStyle = $o['FontAwesomeStyle'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ID)) $o['ID'] = $this->ID;
if (isset($this->GroupID)) $o['GroupID'] = $this->GroupID;
if (isset($this->Type)) $o['Type'] = $this->Type;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Order)) $o['Order'] = $this->Order;
if (isset($this->Cols)) $o['Cols'] = $this->Cols;
if (isset($this->Rows)) $o['Rows'] = $this->Rows;
if (isset($this->Style)) $o['Style'] = $this->Style;
if (isset($this->Data)) $o['Data'] = $this->Data;
if (isset($this->FontAwesomeIcon)) $o['FontAwesomeIcon'] = $this->FontAwesomeIcon;
if (isset($this->FontAwesomeStyle)) $o['FontAwesomeStyle'] = $this->FontAwesomeStyle;
return empty($o) ? new class(){} : $o;
}
}
class TileGroupDto implements JsonSerializable
{
public function __construct(
/** @var string */
public string $ID='',
/** @var string */
public string $DashboardID='',
/** @var string|null */
public ?string $Name=null,
/** @var int */
public int $Cols=0,
/** @var int */
public int $Rows=0,
/** @var int */
public int $Order=0,
/** @var array<TileDto>|null */
public ?array $Tiles=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ID'])) $this->ID = $o['ID'];
if (isset($o['DashboardID'])) $this->DashboardID = $o['DashboardID'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Cols'])) $this->Cols = $o['Cols'];
if (isset($o['Rows'])) $this->Rows = $o['Rows'];
if (isset($o['Order'])) $this->Order = $o['Order'];
if (isset($o['Tiles'])) $this->Tiles = JsonConverters::fromArray('TileDto', $o['Tiles']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ID)) $o['ID'] = $this->ID;
if (isset($this->DashboardID)) $o['DashboardID'] = $this->DashboardID;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Cols)) $o['Cols'] = $this->Cols;
if (isset($this->Rows)) $o['Rows'] = $this->Rows;
if (isset($this->Order)) $o['Order'] = $this->Order;
if (isset($this->Tiles)) $o['Tiles'] = JsonConverters::toArray('TileDto', $this->Tiles);
return empty($o) ? new class(){} : $o;
}
}
class DashboardDto implements JsonSerializable
{
public function __construct(
/** @var string */
public string $ID='',
/** @var int */
public int $UserID=0,
/** @var array<TileGroupDto>|null */
public ?array $TileGroups=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ID'])) $this->ID = $o['ID'];
if (isset($o['UserID'])) $this->UserID = $o['UserID'];
if (isset($o['TileGroups'])) $this->TileGroups = JsonConverters::fromArray('TileGroupDto', $o['TileGroups']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ID)) $o['ID'] = $this->ID;
if (isset($this->UserID)) $o['UserID'] = $this->UserID;
if (isset($this->TileGroups)) $o['TileGroups'] = JsonConverters::toArray('TileGroupDto', $this->TileGroups);
return empty($o) ? new class(){} : $o;
}
}
class GetDashboard implements JsonSerializable
{
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
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.
GET /api/dashboards HTTP/1.1 Host: test-dogw.klokgroep.nl Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
UserID: 0,
TileGroups:
[
{
Name: String,
Cols: 0,
Rows: 0,
Order: 0,
Tiles:
[
{
Type: 0,
Name: String,
Order: 0,
Cols: 0,
Rows: 0,
Style: 0,
Data: String,
FontAwesomeIcon: String,
FontAwesomeStyle: String
}
]
}
]
}