| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,POST,PUT,DELETE,OPTIONS | /v1/NotificationMessage/{NotificationMessageId} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/NotificationMessage |
<?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 NotificationMessage implements JsonSerializable
{
public function __construct(
/** @var int */
public int $NotificationMessageId=0,
/** @var int */
public int $NotificationHeaderId=0,
/** @var int */
public int $SenderId=0,
/** @var string|null */
public ?string $Subject=null,
/** @var string|null */
public ?string $Message=null,
/** @var DateTime */
public DateTime $DateCreated=new DateTime(),
/** @var string|null */
public ?string $SenderName=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['NotificationMessageId'])) $this->NotificationMessageId = $o['NotificationMessageId'];
if (isset($o['NotificationHeaderId'])) $this->NotificationHeaderId = $o['NotificationHeaderId'];
if (isset($o['SenderId'])) $this->SenderId = $o['SenderId'];
if (isset($o['Subject'])) $this->Subject = $o['Subject'];
if (isset($o['Message'])) $this->Message = $o['Message'];
if (isset($o['DateCreated'])) $this->DateCreated = JsonConverters::from('DateTime', $o['DateCreated']);
if (isset($o['SenderName'])) $this->SenderName = $o['SenderName'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->NotificationMessageId)) $o['NotificationMessageId'] = $this->NotificationMessageId;
if (isset($this->NotificationHeaderId)) $o['NotificationHeaderId'] = $this->NotificationHeaderId;
if (isset($this->SenderId)) $o['SenderId'] = $this->SenderId;
if (isset($this->Subject)) $o['Subject'] = $this->Subject;
if (isset($this->Message)) $o['Message'] = $this->Message;
if (isset($this->DateCreated)) $o['DateCreated'] = JsonConverters::to('DateTime', $this->DateCreated);
if (isset($this->SenderName)) $o['SenderName'] = $this->SenderName;
return empty($o) ? new class(){} : $o;
}
}
class NotificationMessageResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var array<NotificationMessage>|null */
public ?array $NotificationMessage=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['NotificationMessage'])) $this->NotificationMessage = JsonConverters::fromArray('NotificationMessage', $o['NotificationMessage']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->NotificationMessage)) $o['NotificationMessage'] = JsonConverters::toArray('NotificationMessage', $this->NotificationMessage);
return empty($o) ? new class(){} : $o;
}
}
class NotificationMessageRequest implements JsonSerializable
{
public function __construct(
/** @var array<NotificationMessage>|null */
public ?array $NotificationMessage=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['NotificationMessage'])) $this->NotificationMessage = JsonConverters::fromArray('NotificationMessage', $o['NotificationMessage']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->NotificationMessage)) $o['NotificationMessage'] = JsonConverters::toArray('NotificationMessage', $this->NotificationMessage);
return empty($o) ? new class(){} : $o;
}
}
PHP NotificationMessageRequest DTOs
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/NotificationMessage/{NotificationMessageId} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
NotificationMessage:
[
{
NotificationMessageId: 0,
NotificationHeaderId: 0,
SenderId: 0,
Subject: String,
Message: String,
DateCreated: 0001-01-01,
SenderName: String
}
]
}
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
}
},
NotificationMessage:
[
{
NotificationMessageId: 0,
NotificationHeaderId: 0,
SenderId: 0,
Subject: String,
Message: String,
DateCreated: 0001-01-01,
SenderName: String
}
]
}