Trendsic Platform Service

ReportDefinitionListRequest

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

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

<?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 SavedReportDefinition implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ReportDefinitionID=0,
        /** @var string */
        public string $ReportDefinitionUID='',
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Folder=null,
        /** @var string|null */
        public ?string $Kind=null,
        /** @var string|null */
        public ?string $ChartType=null,
        /** @var string|null */
        public ?string $DefinitionJson=null,
        /** @var bool|null */
        public ?bool $IsShared=null,
        /** @var bool|null */
        public ?bool $IsSystem=null,
        /** @var string|null */
        public ?string $OwnerUserId=null,
        /** @var bool|null */
        public ?bool $IsMine=null,
        /** @var DateTime|null */
        public ?DateTime $CreatedAt=null,
        /** @var DateTime|null */
        public ?DateTime $UpdatedAt=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ReportDefinitionID'])) $this->ReportDefinitionID = $o['ReportDefinitionID'];
        if (isset($o['ReportDefinitionUID'])) $this->ReportDefinitionUID = $o['ReportDefinitionUID'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Folder'])) $this->Folder = $o['Folder'];
        if (isset($o['Kind'])) $this->Kind = $o['Kind'];
        if (isset($o['ChartType'])) $this->ChartType = $o['ChartType'];
        if (isset($o['DefinitionJson'])) $this->DefinitionJson = $o['DefinitionJson'];
        if (isset($o['IsShared'])) $this->IsShared = $o['IsShared'];
        if (isset($o['IsSystem'])) $this->IsSystem = $o['IsSystem'];
        if (isset($o['OwnerUserId'])) $this->OwnerUserId = $o['OwnerUserId'];
        if (isset($o['IsMine'])) $this->IsMine = $o['IsMine'];
        if (isset($o['CreatedAt'])) $this->CreatedAt = JsonConverters::from('DateTime', $o['CreatedAt']);
        if (isset($o['UpdatedAt'])) $this->UpdatedAt = JsonConverters::from('DateTime', $o['UpdatedAt']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ReportDefinitionID)) $o['ReportDefinitionID'] = $this->ReportDefinitionID;
        if (isset($this->ReportDefinitionUID)) $o['ReportDefinitionUID'] = $this->ReportDefinitionUID;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Folder)) $o['Folder'] = $this->Folder;
        if (isset($this->Kind)) $o['Kind'] = $this->Kind;
        if (isset($this->ChartType)) $o['ChartType'] = $this->ChartType;
        if (isset($this->DefinitionJson)) $o['DefinitionJson'] = $this->DefinitionJson;
        if (isset($this->IsShared)) $o['IsShared'] = $this->IsShared;
        if (isset($this->IsSystem)) $o['IsSystem'] = $this->IsSystem;
        if (isset($this->OwnerUserId)) $o['OwnerUserId'] = $this->OwnerUserId;
        if (isset($this->IsMine)) $o['IsMine'] = $this->IsMine;
        if (isset($this->CreatedAt)) $o['CreatedAt'] = JsonConverters::to('DateTime', $this->CreatedAt);
        if (isset($this->UpdatedAt)) $o['UpdatedAt'] = JsonConverters::to('DateTime', $this->UpdatedAt);
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class ReportDefinitionListRequest implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

PHP ReportDefinitionListRequest 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/report/definitions HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<ReportDefinitionListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Definitions>
    <SavedReportDefinition>
      <ChartType>String</ChartType>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <DefinitionJson>String</DefinitionJson>
      <Folder>String</Folder>
      <IsMine>false</IsMine>
      <IsShared>false</IsShared>
      <IsSystem>false</IsSystem>
      <Kind>String</Kind>
      <Name>String</Name>
      <OwnerUserId>String</OwnerUserId>
      <ReportDefinitionID>0</ReportDefinitionID>
      <ReportDefinitionUID>00000000-0000-0000-0000-000000000000</ReportDefinitionUID>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    </SavedReportDefinition>
  </Definitions>
  <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>
</ReportDefinitionListResponse>