Trendsic Platform Service

<back to all web services

AgentAgreementDocRequest

The following routes are available for this service:
GET,DELETE,POST,PUT,OPTIONS/v1/AgentAgreementDoc/{AgentRegistrationTempId}
GET,DELETE,POST,PUT,OPTIONS/v1/AgentAgreementDoc
<?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 AgentAgreementDoc implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Id=0,
        /** @var string|null */
        public ?string $ApplicationId=null,
        /** @var string|null */
        public ?string $Name=null,
        /** @var int */
        public int $Version=0,
        /** @var string|null */
        public ?string $LegalRegion=null,
        /** @var string|null */
        public ?string $Section=null,
        /** @var string|null */
        public ?string $FileExtension=null,
        /** @var string|null */
        public ?string $FileName=null,
        /** @var int */
        public int $Order=0,
        /** @var bool|null */
        public ?bool $Active=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['ApplicationId'])) $this->ApplicationId = $o['ApplicationId'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Version'])) $this->Version = $o['Version'];
        if (isset($o['LegalRegion'])) $this->LegalRegion = $o['LegalRegion'];
        if (isset($o['Section'])) $this->Section = $o['Section'];
        if (isset($o['FileExtension'])) $this->FileExtension = $o['FileExtension'];
        if (isset($o['FileName'])) $this->FileName = $o['FileName'];
        if (isset($o['Order'])) $this->Order = $o['Order'];
        if (isset($o['Active'])) $this->Active = $o['Active'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->ApplicationId)) $o['ApplicationId'] = $this->ApplicationId;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Version)) $o['Version'] = $this->Version;
        if (isset($this->LegalRegion)) $o['LegalRegion'] = $this->LegalRegion;
        if (isset($this->Section)) $o['Section'] = $this->Section;
        if (isset($this->FileExtension)) $o['FileExtension'] = $this->FileExtension;
        if (isset($this->FileName)) $o['FileName'] = $this->FileName;
        if (isset($this->Order)) $o['Order'] = $this->Order;
        if (isset($this->Active)) $o['Active'] = $this->Active;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class AgentAgreementDocRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgentRegistrationTempId=0
    ) {
    }

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

PHP AgentAgreementDocRequest 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/AgentAgreementDoc/{AgentRegistrationTempId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"AgentRegistrationTempId":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"}},"AgentAgreementDisclosureDocs":[{"Id":0,"ApplicationId":"String","Name":"String","Version":0,"LegalRegion":"String","Section":"String","FileExtension":"String","FileName":"String","Order":0,"Active":false}]}