Trendsic Platform Service

NoticeAgreementRequest

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

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

<?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 NoticeAgreement implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Id=0,
        /** @var int */
        public int $AgentId=0,
        /** @var string|null */
        public ?string $AgentName=null,
        /** @var string|null */
        public ?string $Status=null,
        /** @var DateTime */
        public DateTime $SignedDate=new DateTime(),
        /** @var DateTime */
        public DateTime $FirstViewed=new DateTime(),
        /** @var DateTime */
        public DateTime $SnoozedDate=new DateTime()
    ) {
    }

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

class NoticeAgreementResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var NoticeAgreement|null */
        public ?NoticeAgreement $AgentAgreement=null
    ) {
    }

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

class NoticeAgreementRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgentId=0,
        /** @var string|null */
        public ?string $Status=null
    ) {
    }

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

PHP NoticeAgreementRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/noticeAgreement/{AgentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AgentId: 0,
	Status: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	AgentAgreement: 
	{
		Id: 0,
		AgentId: 0,
		AgentName: String,
		Status: String,
		SignedDate: 0001-01-01,
		FirstViewed: 0001-01-01,
		SnoozedDate: 0001-01-01
	}
}