Trendsic Platform Service

NotificationsRequest

**Requires Authentication**
Requires any of the roles:	Worker, Agent, Administrator

The following routes are available for this service:
GET,OPTIONS	/v1/Notifications

<?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 NotificationHeader implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $NotificationHeaderId=0,
        /** @var string|null */
        public ?string $Subject=null,
        /** @var string|null */
        public ?string $Status=null,
        /** @var bool|null */
        public ?bool $NeedsCloseApproval=null,
        /** @var bool|null */
        public ?bool $IsDeleted=null,
        /** @var int */
        public int $CreatedBy=0,
        /** @var DateTime */
        public DateTime $DateCreated=new DateTime()
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['NotificationHeaderId'])) $this->NotificationHeaderId = $o['NotificationHeaderId'];
        if (isset($o['Subject'])) $this->Subject = $o['Subject'];
        if (isset($o['Status'])) $this->Status = $o['Status'];
        if (isset($o['NeedsCloseApproval'])) $this->NeedsCloseApproval = $o['NeedsCloseApproval'];
        if (isset($o['IsDeleted'])) $this->IsDeleted = $o['IsDeleted'];
        if (isset($o['CreatedBy'])) $this->CreatedBy = $o['CreatedBy'];
        if (isset($o['DateCreated'])) $this->DateCreated = JsonConverters::from('DateTime', $o['DateCreated']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->NotificationHeaderId)) $o['NotificationHeaderId'] = $this->NotificationHeaderId;
        if (isset($this->Subject)) $o['Subject'] = $this->Subject;
        if (isset($this->Status)) $o['Status'] = $this->Status;
        if (isset($this->NeedsCloseApproval)) $o['NeedsCloseApproval'] = $this->NeedsCloseApproval;
        if (isset($this->IsDeleted)) $o['IsDeleted'] = $this->IsDeleted;
        if (isset($this->CreatedBy)) $o['CreatedBy'] = $this->CreatedBy;
        if (isset($this->DateCreated)) $o['DateCreated'] = JsonConverters::to('DateTime', $this->DateCreated);
        return empty($o) ? new class(){} : $o;
    }
}

class Notification extends NotificationHeader implements JsonSerializable
{
    /**
     * @param int $NotificationHeaderId
     * @param string|null $Subject
     * @param string|null $Status
     * @param bool|null $NeedsCloseApproval
     * @param bool|null $IsDeleted
     * @param int $CreatedBy
     * @param DateTime $DateCreated
     */
    public function __construct(
        int $NotificationHeaderId=0,
        ?string $Subject=null,
        ?string $Status=null,
        ?bool $NeedsCloseApproval=null,
        ?bool $IsDeleted=null,
        int $CreatedBy=0,
        DateTime $DateCreated=new DateTime()
    ) {
        parent::__construct($NotificationHeaderId,$Subject,$Status,$NeedsCloseApproval,$IsDeleted,$CreatedBy,$DateCreated);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        return empty($o) ? new class(){} : $o;
    }
}

class NotificationsResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<Notification>|null */
        public ?array $Notifications=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
        if (isset($o['Notifications'])) $this->Notifications = JsonConverters::fromArray('Notification', $o['Notifications']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        if (isset($this->Notifications)) $o['Notifications'] = JsonConverters::toArray('Notification', $this->Notifications);
        return empty($o) ? new class(){} : $o;
    }
}

class NotificationsRequest implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

PHP NotificationsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/Notifications HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<NotificationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Notifications>
    <Notification>
      <CreatedBy>0</CreatedBy>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <IsDeleted>false</IsDeleted>
      <NeedsCloseApproval>false</NeedsCloseApproval>
      <NotificationHeaderId>0</NotificationHeaderId>
      <Status>String</Status>
      <Subject>String</Subject>
      <LastMessage>
        <DateCreated>0001-01-01T00:00:00</DateCreated>
        <Message>String</Message>
        <NotificationHeaderId>0</NotificationHeaderId>
        <NotificationMessageId>0</NotificationMessageId>
        <SenderId>0</SenderId>
        <SenderName>String</SenderName>
        <Subject>String</Subject>
      </LastMessage>
    </Notification>
  </Notifications>
  <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>
</NotificationsResponse>