Trendsic Platform Service

AgentAgreementRequest

**Requires Authentication**
Requires any of the roles:	Worker, Agent, Administrator

The following routes are available for this service:
GET,DELETE,POST,PUT,OPTIONS	/v1/AgentAgreement/{AgentId}

<?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 AgentAgreement implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Id=0,
        /** @var int */
        public int $AgentRegistrationTempId=0,
        /** @var int */
        public int $AgentAgreementDocId=0,
        /** @var bool|null */
        public ?bool $Signed=null,
        /** @var DateTime */
        public DateTime $SignedDate=new DateTime(),
        /** @var string|null */
        public ?string $FileName=null
    ) {
    }

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

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

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

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

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

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

{"AgentId":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"}},"AgentAgreements":[{"Id":0,"AgentRegistrationTempId":0,"AgentAgreementDocId":0,"Signed":false,"SignedDate":"0001-01-01T00:00:00.0000000","FileName":"String"}]}