Trendsic Platform Service

NoticeAdminRequest

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

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

<?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 Notice implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $NoticeId=0,
        /** @var DateTime */
        public DateTime $BeginDate=new DateTime(),
        /** @var DateTime */
        public DateTime $ExpireDate=new DateTime(),
        /** @var string|null */
        public ?string $NoticeTitle=null,
        /** @var string|null */
        public ?string $NoticeDescription=null,
        /** @var string|null */
        public ?string $NoticeFullText=null,
        /** @var int */
        public int $OrderIndex=0,
        /** @var bool|null */
        public ?bool $IsActive=null,
        /** @var bool|null */
        public ?bool $IsUrgent=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['NoticeId'])) $this->NoticeId = $o['NoticeId'];
        if (isset($o['BeginDate'])) $this->BeginDate = JsonConverters::from('DateTime', $o['BeginDate']);
        if (isset($o['ExpireDate'])) $this->ExpireDate = JsonConverters::from('DateTime', $o['ExpireDate']);
        if (isset($o['NoticeTitle'])) $this->NoticeTitle = $o['NoticeTitle'];
        if (isset($o['NoticeDescription'])) $this->NoticeDescription = $o['NoticeDescription'];
        if (isset($o['NoticeFullText'])) $this->NoticeFullText = $o['NoticeFullText'];
        if (isset($o['OrderIndex'])) $this->OrderIndex = $o['OrderIndex'];
        if (isset($o['IsActive'])) $this->IsActive = $o['IsActive'];
        if (isset($o['IsUrgent'])) $this->IsUrgent = $o['IsUrgent'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->NoticeId)) $o['NoticeId'] = $this->NoticeId;
        if (isset($this->BeginDate)) $o['BeginDate'] = JsonConverters::to('DateTime', $this->BeginDate);
        if (isset($this->ExpireDate)) $o['ExpireDate'] = JsonConverters::to('DateTime', $this->ExpireDate);
        if (isset($this->NoticeTitle)) $o['NoticeTitle'] = $this->NoticeTitle;
        if (isset($this->NoticeDescription)) $o['NoticeDescription'] = $this->NoticeDescription;
        if (isset($this->NoticeFullText)) $o['NoticeFullText'] = $this->NoticeFullText;
        if (isset($this->OrderIndex)) $o['OrderIndex'] = $this->OrderIndex;
        if (isset($this->IsActive)) $o['IsActive'] = $this->IsActive;
        if (isset($this->IsUrgent)) $o['IsUrgent'] = $this->IsUrgent;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class NoticeAdminRequest implements JsonSerializable
{
    public function __construct(
        /** @var DateTime */
        public DateTime $DateAsOf=new DateTime(),
        /** @var int */
        public int $NoticeID=0,
        /** @var array<Notice>|null */
        public ?array $Notice=null
    ) {
    }

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

PHP NoticeAdminRequest DTOs

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

HTTP + XML

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

POST /v1/NoticeAdmin/{NoticeId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<NoticeAdminRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DateAsOf>0001-01-01T00:00:00</DateAsOf>
  <Notice>
    <Notice>
      <BeginDate>0001-01-01T00:00:00</BeginDate>
      <ExpireDate>0001-01-01T00:00:00</ExpireDate>
      <IsActive>false</IsActive>
      <IsUrgent>false</IsUrgent>
      <NoticeDescription>String</NoticeDescription>
      <NoticeFullText>String</NoticeFullText>
      <NoticeId>0</NoticeId>
      <NoticeTitle>String</NoticeTitle>
      <OrderIndex>0</OrderIndex>
    </Notice>
  </Notice>
  <NoticeID>0</NoticeID>
</NoticeAdminRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<NoticeAdminResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Notice>
    <Notice>
      <BeginDate>0001-01-01T00:00:00</BeginDate>
      <ExpireDate>0001-01-01T00:00:00</ExpireDate>
      <IsActive>false</IsActive>
      <IsUrgent>false</IsUrgent>
      <NoticeDescription>String</NoticeDescription>
      <NoticeFullText>String</NoticeFullText>
      <NoticeId>0</NoticeId>
      <NoticeTitle>String</NoticeTitle>
      <OrderIndex>0</OrderIndex>
    </Notice>
  </Notice>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</NoticeAdminResponse>