Trendsic Platform Service

DashboardStatsRequest

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

The following routes are available for this service:
GET,OPTIONS	/v1/DashboardStats

<?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 DashboardItem implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ID=0,
        /** @var DateTime|null */
        public ?DateTime $Date=null,
        /** @var string|null */
        public ?string $Title=null,
        /** @var string|null */
        public ?string $Message=null,
        /** @var string|null */
        public ?string $Author=null,
        /** @var string|null */
        public ?string $Hyperlink=null,
        /** @var string|null */
        public ?string $ThumbnailImage=null,
        /** @var DateTime|null */
        public ?DateTime $StartDate=null,
        /** @var DateTime|null */
        public ?DateTime $EndDate=null,
        /** @var string|null */
        public ?string $Type=null,
        /** @var int */
        public int $SortKey=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ID'])) $this->ID = $o['ID'];
        if (isset($o['Date'])) $this->Date = JsonConverters::from('DateTime', $o['Date']);
        if (isset($o['Title'])) $this->Title = $o['Title'];
        if (isset($o['Message'])) $this->Message = $o['Message'];
        if (isset($o['Author'])) $this->Author = $o['Author'];
        if (isset($o['Hyperlink'])) $this->Hyperlink = $o['Hyperlink'];
        if (isset($o['ThumbnailImage'])) $this->ThumbnailImage = $o['ThumbnailImage'];
        if (isset($o['StartDate'])) $this->StartDate = JsonConverters::from('DateTime', $o['StartDate']);
        if (isset($o['EndDate'])) $this->EndDate = JsonConverters::from('DateTime', $o['EndDate']);
        if (isset($o['Type'])) $this->Type = $o['Type'];
        if (isset($o['SortKey'])) $this->SortKey = $o['SortKey'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ID)) $o['ID'] = $this->ID;
        if (isset($this->Date)) $o['Date'] = JsonConverters::to('DateTime', $this->Date);
        if (isset($this->Title)) $o['Title'] = $this->Title;
        if (isset($this->Message)) $o['Message'] = $this->Message;
        if (isset($this->Author)) $o['Author'] = $this->Author;
        if (isset($this->Hyperlink)) $o['Hyperlink'] = $this->Hyperlink;
        if (isset($this->ThumbnailImage)) $o['ThumbnailImage'] = $this->ThumbnailImage;
        if (isset($this->StartDate)) $o['StartDate'] = JsonConverters::to('DateTime', $this->StartDate);
        if (isset($this->EndDate)) $o['EndDate'] = JsonConverters::to('DateTime', $this->EndDate);
        if (isset($this->Type)) $o['Type'] = $this->Type;
        if (isset($this->SortKey)) $o['SortKey'] = $this->SortKey;
        return empty($o) ? new class(){} : $o;
    }
}

class DashboardItemResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<DashboardItem>|null */
        public ?array $GeneralMessages=null,
        /** @var array<DashboardItem>|null */
        public ?array $PersonCallouts=null,
        /** @var array<DashboardItem>|null */
        public ?array $TipOfTheWeek=null,
        /** @var array<DashboardItem>|null */
        public ?array $NewsAndNotes=null
    ) {
    }

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

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

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

PHP DashboardStatsRequest 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.

GET /v1/DashboardStats HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<DashboardItemResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <GeneralMessages>
    <DashboardItem>
      <Author>String</Author>
      <Date>0001-01-01T00:00:00</Date>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <Hyperlink>String</Hyperlink>
      <ID>0</ID>
      <Message>String</Message>
      <SortKey>0</SortKey>
      <StartDate>0001-01-01T00:00:00</StartDate>
      <ThumbnailImage>String</ThumbnailImage>
      <Title>String</Title>
      <Type>String</Type>
    </DashboardItem>
  </GeneralMessages>
  <NewsAndNotes>
    <DashboardItem>
      <Author>String</Author>
      <Date>0001-01-01T00:00:00</Date>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <Hyperlink>String</Hyperlink>
      <ID>0</ID>
      <Message>String</Message>
      <SortKey>0</SortKey>
      <StartDate>0001-01-01T00:00:00</StartDate>
      <ThumbnailImage>String</ThumbnailImage>
      <Title>String</Title>
      <Type>String</Type>
    </DashboardItem>
  </NewsAndNotes>
  <PersonCallouts>
    <DashboardItem>
      <Author>String</Author>
      <Date>0001-01-01T00:00:00</Date>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <Hyperlink>String</Hyperlink>
      <ID>0</ID>
      <Message>String</Message>
      <SortKey>0</SortKey>
      <StartDate>0001-01-01T00:00:00</StartDate>
      <ThumbnailImage>String</ThumbnailImage>
      <Title>String</Title>
      <Type>String</Type>
    </DashboardItem>
  </PersonCallouts>
  <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>
  <TipOfTheWeek>
    <DashboardItem>
      <Author>String</Author>
      <Date>0001-01-01T00:00:00</Date>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <Hyperlink>String</Hyperlink>
      <ID>0</ID>
      <Message>String</Message>
      <SortKey>0</SortKey>
      <StartDate>0001-01-01T00:00:00</StartDate>
      <ThumbnailImage>String</ThumbnailImage>
      <Title>String</Title>
      <Type>String</Type>
    </DashboardItem>
  </TipOfTheWeek>
</DashboardItemResponse>