| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,POST,PUT,DELETE,OPTIONS | /v1/NoticeAdmin/{NoticeId} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/NoticeAdmin/ |
<?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 Notice implements JsonSerializable
{
public function __construct(
/** @var int */
public int $NoticeId=0,
/** @var DateTime */
public DateTime $BeginDate=new DateTime(),
/** @var DateTime */
public DateTime $ExpireDate=new DateTime(),
/** @var string|null */
public ?string $NoticeTitle=null,
/** @var string|null */
public ?string $NoticeDescription=null,
/** @var string|null */
public ?string $NoticeFullText=null,
/** @var int */
public int $OrderIndex=0,
/** @var bool|null */
public ?bool $IsActive=null,
/** @var bool|null */
public ?bool $IsUrgent=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['NoticeId'])) $this->NoticeId = $o['NoticeId'];
if (isset($o['BeginDate'])) $this->BeginDate = JsonConverters::from('DateTime', $o['BeginDate']);
if (isset($o['ExpireDate'])) $this->ExpireDate = JsonConverters::from('DateTime', $o['ExpireDate']);
if (isset($o['NoticeTitle'])) $this->NoticeTitle = $o['NoticeTitle'];
if (isset($o['NoticeDescription'])) $this->NoticeDescription = $o['NoticeDescription'];
if (isset($o['NoticeFullText'])) $this->NoticeFullText = $o['NoticeFullText'];
if (isset($o['OrderIndex'])) $this->OrderIndex = $o['OrderIndex'];
if (isset($o['IsActive'])) $this->IsActive = $o['IsActive'];
if (isset($o['IsUrgent'])) $this->IsUrgent = $o['IsUrgent'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->NoticeId)) $o['NoticeId'] = $this->NoticeId;
if (isset($this->BeginDate)) $o['BeginDate'] = JsonConverters::to('DateTime', $this->BeginDate);
if (isset($this->ExpireDate)) $o['ExpireDate'] = JsonConverters::to('DateTime', $this->ExpireDate);
if (isset($this->NoticeTitle)) $o['NoticeTitle'] = $this->NoticeTitle;
if (isset($this->NoticeDescription)) $o['NoticeDescription'] = $this->NoticeDescription;
if (isset($this->NoticeFullText)) $o['NoticeFullText'] = $this->NoticeFullText;
if (isset($this->OrderIndex)) $o['OrderIndex'] = $this->OrderIndex;
if (isset($this->IsActive)) $o['IsActive'] = $this->IsActive;
if (isset($this->IsUrgent)) $o['IsUrgent'] = $this->IsUrgent;
return empty($o) ? new class(){} : $o;
}
}
class NoticeAdminResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var array<Notice>|null */
public ?array $Notice=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['Notice'])) $this->Notice = JsonConverters::fromArray('Notice', $o['Notice']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->Notice)) $o['Notice'] = JsonConverters::toArray('Notice', $this->Notice);
return empty($o) ? new class(){} : $o;
}
}
class NoticeAdminRequest implements JsonSerializable
{
public function __construct(
/** @var DateTime */
public DateTime $DateAsOf=new DateTime(),
/** @var int */
public int $NoticeID=0,
/** @var array<Notice>|null */
public ?array $Notice=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['DateAsOf'])) $this->DateAsOf = JsonConverters::from('DateTime', $o['DateAsOf']);
if (isset($o['NoticeID'])) $this->NoticeID = $o['NoticeID'];
if (isset($o['Notice'])) $this->Notice = JsonConverters::fromArray('Notice', $o['Notice']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->DateAsOf)) $o['DateAsOf'] = JsonConverters::to('DateTime', $this->DateAsOf);
if (isset($this->NoticeID)) $o['NoticeID'] = $this->NoticeID;
if (isset($this->Notice)) $o['Notice'] = JsonConverters::toArray('Notice', $this->Notice);
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/NoticeAdmin/{NoticeId} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"DateAsOf":"0001-01-01T00:00:00.0000000","NoticeID":0,"Notice":[{"NoticeId":0,"BeginDate":"0001-01-01T00:00:00.0000000","ExpireDate":"0001-01-01T00:00:00.0000000","NoticeTitle":"String","NoticeDescription":"String","NoticeFullText":"String","OrderIndex":0,"IsActive":false,"IsUrgent":false}]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Notice":[{"NoticeId":0,"BeginDate":"0001-01-01T00:00:00.0000000","ExpireDate":"0001-01-01T00:00:00.0000000","NoticeTitle":"String","NoticeDescription":"String","NoticeFullText":"String","OrderIndex":0,"IsActive":false,"IsUrgent":false}]}