| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/DashboardAdmin/{DashboardItemId} | ||
|---|---|---|---|
| GET,PUT,POST,DELETE,OPTIONS | /v1/DashboardAdmin |
<?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 DashboardItem implements JsonSerializable
{
public function __construct(
/** @var int */
public int $ID=0,
/** @var DateTime|null */
public ?DateTime $Date=null,
/** @var string|null */
public ?string $Title=null,
/** @var string|null */
public ?string $Message=null,
/** @var string|null */
public ?string $Author=null,
/** @var string|null */
public ?string $Hyperlink=null,
/** @var string|null */
public ?string $ThumbnailImage=null,
/** @var DateTime|null */
public ?DateTime $StartDate=null,
/** @var DateTime|null */
public ?DateTime $EndDate=null,
/** @var string|null */
public ?string $Type=null,
/** @var int */
public int $SortKey=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ID'])) $this->ID = $o['ID'];
if (isset($o['Date'])) $this->Date = JsonConverters::from('DateTime', $o['Date']);
if (isset($o['Title'])) $this->Title = $o['Title'];
if (isset($o['Message'])) $this->Message = $o['Message'];
if (isset($o['Author'])) $this->Author = $o['Author'];
if (isset($o['Hyperlink'])) $this->Hyperlink = $o['Hyperlink'];
if (isset($o['ThumbnailImage'])) $this->ThumbnailImage = $o['ThumbnailImage'];
if (isset($o['StartDate'])) $this->StartDate = JsonConverters::from('DateTime', $o['StartDate']);
if (isset($o['EndDate'])) $this->EndDate = JsonConverters::from('DateTime', $o['EndDate']);
if (isset($o['Type'])) $this->Type = $o['Type'];
if (isset($o['SortKey'])) $this->SortKey = $o['SortKey'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ID)) $o['ID'] = $this->ID;
if (isset($this->Date)) $o['Date'] = JsonConverters::to('DateTime', $this->Date);
if (isset($this->Title)) $o['Title'] = $this->Title;
if (isset($this->Message)) $o['Message'] = $this->Message;
if (isset($this->Author)) $o['Author'] = $this->Author;
if (isset($this->Hyperlink)) $o['Hyperlink'] = $this->Hyperlink;
if (isset($this->ThumbnailImage)) $o['ThumbnailImage'] = $this->ThumbnailImage;
if (isset($this->StartDate)) $o['StartDate'] = JsonConverters::to('DateTime', $this->StartDate);
if (isset($this->EndDate)) $o['EndDate'] = JsonConverters::to('DateTime', $this->EndDate);
if (isset($this->Type)) $o['Type'] = $this->Type;
if (isset($this->SortKey)) $o['SortKey'] = $this->SortKey;
return empty($o) ? new class(){} : $o;
}
}
class DashboardAdminRequest implements JsonSerializable
{
public function __construct(
/** @var DashboardItem|null */
public ?DashboardItem $DashboardItem=null,
/** @var string|null */
public ?string $DashboardItemId=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['DashboardItem'])) $this->DashboardItem = JsonConverters::from('DashboardItem', $o['DashboardItem']);
if (isset($o['DashboardItemId'])) $this->DashboardItemId = $o['DashboardItemId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->DashboardItem)) $o['DashboardItem'] = JsonConverters::to('DashboardItem', $this->DashboardItem);
if (isset($this->DashboardItemId)) $o['DashboardItemId'] = $this->DashboardItemId;
return empty($o) ? new class(){} : $o;
}
}
PHP DashboardAdminRequest DTOs
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.
POST /v1/DashboardAdmin HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"DashboardItem":{"ID":0,"Date":"0001-01-01T00:00:00.0000000","Title":"String","Message":"String","Author":"String","Hyperlink":"String","ThumbnailImage":"String","StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","Type":"String","SortKey":0},"DashboardItemId":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ID":0,"Date":"0001-01-01T00:00:00.0000000","Title":"String","Message":"String","Author":"String","Hyperlink":"String","ThumbnailImage":"String","StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","Type":"String","SortKey":0}