Trendsic Platform Service

<back to all web services

NotificationHeaderRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/NotificationHeader/{NotificationHeaderId}
GET,POST,PUT,DELETE,OPTIONS/v1/NotificationHeader
<?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 NotificationHeaderResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<NotificationHeader>|null */
        public ?array $NotificationHeader=null
    ) {
    }

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

class NotificationHeaderRequest implements JsonSerializable
{
    public function __construct(
        /** @var array<NotificationHeader>|null */
        public ?array $NotificationHeader=null
    ) {
    }

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

PHP NotificationHeaderRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /v1/NotificationHeader/{NotificationHeaderId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"NotificationHeader":[{"NotificationHeaderId":0,"Subject":"String","Status":"String","NeedsCloseApproval":false,"IsDeleted":false,"CreatedBy":0,"DateCreated":"0001-01-01T00:00:00.0000000"}]}

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

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"NotificationHeader":[{"NotificationHeaderId":0,"Subject":"String","Status":"String","NeedsCloseApproval":false,"IsDeleted":false,"CreatedBy":0,"DateCreated":"0001-01-01T00:00:00.0000000"}]}