Trendsic Platform Service

<back to all web services

PolicyDocumentRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
DELETE,OPTIONS/v1/PolicyDocument/{Id}
GET,POST,PUT,OPTIONS/v1/PolicyDocument
<?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 PolicyDocument implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Id=0,
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Type=null,
        /** @var bool|null */
        public ?bool $IsDefault=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Type'])) $this->Type = $o['Type'];
        if (isset($o['IsDefault'])) $this->IsDefault = $o['IsDefault'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Type)) $o['Type'] = $this->Type;
        if (isset($this->IsDefault)) $o['IsDefault'] = $this->IsDefault;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class PolicyDocumentRequest implements JsonSerializable
{
    public function __construct(
        /** @var PolicyDocument|null */
        public ?PolicyDocument $PolicyDocument=null,
        /** @var int */
        public int $Id=0
    ) {
    }

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

PHP PolicyDocumentRequest 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/PolicyDocument HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"PolicyDocument":{"Id":0,"Name":"String","Type":"String","IsDefault":false},"Id":0}
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"}},"PolicyDocuments":[{"Id":0,"Name":"String","Type":"String","IsDefault":false}]}