Trendsic Platform Service

<back to all web services

DocumentPolicyRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/document/policy
<?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 DocumentPolicyRule implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Extension=null,
        /** @var string|null */
        public ?string $Category=null,
        /** @var string|null */
        public ?string $Viewer=null,
        /** @var string|null */
        public ?string $MimeType=null,
        /** @var int */
        public int $MaxMB=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Extension'])) $this->Extension = $o['Extension'];
        if (isset($o['Category'])) $this->Category = $o['Category'];
        if (isset($o['Viewer'])) $this->Viewer = $o['Viewer'];
        if (isset($o['MimeType'])) $this->MimeType = $o['MimeType'];
        if (isset($o['MaxMB'])) $this->MaxMB = $o['MaxMB'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Extension)) $o['Extension'] = $this->Extension;
        if (isset($this->Category)) $o['Category'] = $this->Category;
        if (isset($this->Viewer)) $o['Viewer'] = $this->Viewer;
        if (isset($this->MimeType)) $o['MimeType'] = $this->MimeType;
        if (isset($this->MaxMB)) $o['MaxMB'] = $this->MaxMB;
        return empty($o) ? new class(){} : $o;
    }
}

class DocumentPolicyResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var string|null */
        public ?string $Accept=null,
        /** @var array<DocumentPolicyRule>|null */
        public ?array $Rules=null
    ) {
    }

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

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

PHP DocumentPolicyRequest 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.

GET /v1/document/policy HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
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"}},"Accept":"String","Rules":[{"Extension":"String","Category":"String","Viewer":"String","MimeType":"String","MaxMB":0}]}