Trendsic Platform Service

<back to all web services

PolicyDocumentReminderRequest

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

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['PolicyDocumentId'])) $this->PolicyDocumentId = $o['PolicyDocumentId'];
        if (isset($o['ReminderFor'])) $this->ReminderFor = $o['ReminderFor'];
        if (isset($o['ReminderLeadTime'])) $this->ReminderLeadTime = $o['ReminderLeadTime'];
        if (isset($o['ReminderMessage'])) $this->ReminderMessage = $o['ReminderMessage'];
        if (isset($o['AdminAgentId'])) $this->AdminAgentId = $o['AdminAgentId'];
        if (isset($o['NeedsPrompt'])) $this->NeedsPrompt = $o['NeedsPrompt'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->PolicyDocumentId)) $o['PolicyDocumentId'] = $this->PolicyDocumentId;
        if (isset($this->ReminderFor)) $o['ReminderFor'] = $this->ReminderFor;
        if (isset($this->ReminderLeadTime)) $o['ReminderLeadTime'] = $this->ReminderLeadTime;
        if (isset($this->ReminderMessage)) $o['ReminderMessage'] = $this->ReminderMessage;
        if (isset($this->AdminAgentId)) $o['AdminAgentId'] = $this->AdminAgentId;
        if (isset($this->NeedsPrompt)) $o['NeedsPrompt'] = $this->NeedsPrompt;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class PolicyDocumentReminderRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Id=0,
        /** @var int */
        public int $PolicyDocumentId=0,
        /** @var PolicyDocumentReminder|null */
        public ?PolicyDocumentReminder $Reminder=null
    ) {
    }

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

PHP PolicyDocumentReminderRequest 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/PolicyDocumentReminder/ HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Id":0,"PolicyDocumentId":0,"Reminder":{"Id":0,"PolicyDocumentId":0,"ReminderFor":"String","ReminderLeadTime":0,"ReminderMessage":"String","AdminAgentId":0,"NeedsPrompt":false}}

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"}},"PolicyDocumentReminder":[{"Id":0,"PolicyDocumentId":0,"ReminderFor":"String","ReminderLeadTime":0,"ReminderMessage":"String","AdminAgentId":0,"NeedsPrompt":false}]}