Trendsic Platform Service

<back to all web services

NotificationAttachmentRequest

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/NotificationAttachment/{NotificationAttachmentId}
GET,POST,PUT,DELETE,OPTIONS/v1/NotificationAttachment
<?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 NotificationAttachment implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $NotificationAttachmentId=0,
        /** @var int */
        public int $NotificationMessageId=0,
        /** @var ByteArray|null */
        public ?ByteArray $Attachment=null,
        /** @var string|null */
        public ?string $FileName=null,
        /** @var string|null */
        public ?string $MimeType=null,
        /** @var float */
        public float $FileSizeInKB=0.0,
        /** @var DateTime */
        public DateTime $DateCreated=new DateTime()
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['NotificationAttachmentId'])) $this->NotificationAttachmentId = $o['NotificationAttachmentId'];
        if (isset($o['NotificationMessageId'])) $this->NotificationMessageId = $o['NotificationMessageId'];
        if (isset($o['Attachment'])) $this->Attachment = JsonConverters::from('ByteArray', $o['Attachment']);
        if (isset($o['FileName'])) $this->FileName = $o['FileName'];
        if (isset($o['MimeType'])) $this->MimeType = $o['MimeType'];
        if (isset($o['FileSizeInKB'])) $this->FileSizeInKB = $o['FileSizeInKB'];
        if (isset($o['DateCreated'])) $this->DateCreated = JsonConverters::from('DateTime', $o['DateCreated']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->NotificationAttachmentId)) $o['NotificationAttachmentId'] = $this->NotificationAttachmentId;
        if (isset($this->NotificationMessageId)) $o['NotificationMessageId'] = $this->NotificationMessageId;
        if (isset($this->Attachment)) $o['Attachment'] = JsonConverters::to('ByteArray', $this->Attachment);
        if (isset($this->FileName)) $o['FileName'] = $this->FileName;
        if (isset($this->MimeType)) $o['MimeType'] = $this->MimeType;
        if (isset($this->FileSizeInKB)) $o['FileSizeInKB'] = $this->FileSizeInKB;
        if (isset($this->DateCreated)) $o['DateCreated'] = JsonConverters::to('DateTime', $this->DateCreated);
        return empty($o) ? new class(){} : $o;
    }
}

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

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

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

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

PHP NotificationAttachmentRequest DTOs

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

HTTP + OTHER

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

POST /v1/NotificationAttachment/{NotificationAttachmentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"NotificationAttachment":[{"NotificationAttachmentId":0,"NotificationMessageId":0,"Attachment":"AA==","FileName":"String","MimeType":"String","FileSizeInKB":0,"DateCreated":"0001-01-01T00:00:00.0000000"}]}
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"}},"NotificationAttachment":[{"NotificationAttachmentId":0,"NotificationMessageId":0,"Attachment":"AA==","FileName":"String","MimeType":"String","FileSizeInKB":0,"DateCreated":"0001-01-01T00:00:00.0000000"}]}