| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,POST,PUT,DELETE,OPTIONS | /v1/IncomingNotifications/{Id} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/IncomingNotifications |
<?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 IncomingNotificationObject implements JsonSerializable
{
public function __construct(
/** @var string */
public string $Id='',
/** @var string */
public string $CustomerId='',
/** @var string|null */
public ?string $Message=null,
/** @var string */
public string $NotificationMethod='',
/** @var DateTime */
public DateTime $DateReceived=new DateTime()
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['CustomerId'])) $this->CustomerId = $o['CustomerId'];
if (isset($o['Message'])) $this->Message = $o['Message'];
if (isset($o['NotificationMethod'])) $this->NotificationMethod = $o['NotificationMethod'];
if (isset($o['DateReceived'])) $this->DateReceived = JsonConverters::from('DateTime', $o['DateReceived']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->CustomerId)) $o['CustomerId'] = $this->CustomerId;
if (isset($this->Message)) $o['Message'] = $this->Message;
if (isset($this->NotificationMethod)) $o['NotificationMethod'] = $this->NotificationMethod;
if (isset($this->DateReceived)) $o['DateReceived'] = JsonConverters::to('DateTime', $this->DateReceived);
return empty($o) ? new class(){} : $o;
}
}
class IncomingNotificationsResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var array<IncomingNotificationObject>|null */
public ?array $IncomingNotifications=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['IncomingNotifications'])) $this->IncomingNotifications = JsonConverters::fromArray('IncomingNotificationObject', $o['IncomingNotifications']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->IncomingNotifications)) $o['IncomingNotifications'] = JsonConverters::toArray('IncomingNotificationObject', $this->IncomingNotifications);
return empty($o) ? new class(){} : $o;
}
}
class IncomingNotifications extends IncomingNotificationObject implements JsonSerializable
{
/**
* @param string $Id
* @param string $CustomerId
* @param string|null $Message
* @param string $NotificationMethod
* @param DateTime $DateReceived
*/
public function __construct(
string $Id='',
string $CustomerId='',
?string $Message=null,
string $NotificationMethod='',
DateTime $DateReceived=new DateTime(),
/** @var string */
public string $ApiKey=''
) {
parent::__construct($Id,$CustomerId,$Message,$NotificationMethod,$DateReceived);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['ApiKey'])) $this->ApiKey = $o['ApiKey'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->ApiKey)) $o['ApiKey'] = $this->ApiKey;
return empty($o) ? new class(){} : $o;
}
}
PHP IncomingNotifications DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/IncomingNotifications/{Id} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<IncomingNotifications xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<DateReceived>0001-01-01T00:00:00</DateReceived>
<Id>00000000-0000-0000-0000-000000000000</Id>
<Message>String</Message>
<NotificationMethod>00000000-0000-0000-0000-000000000000</NotificationMethod>
<ApiKey>00000000-0000-0000-0000-000000000000</ApiKey>
</IncomingNotifications>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<IncomingNotificationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<IncomingNotifications>
<IncomingNotificationObject>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<DateReceived>0001-01-01T00:00:00</DateReceived>
<Id>00000000-0000-0000-0000-000000000000</Id>
<Message>String</Message>
<NotificationMethod>00000000-0000-0000-0000-000000000000</NotificationMethod>
</IncomingNotificationObject>
</IncomingNotifications>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</IncomingNotificationsResponse>