Trendsic Platform Service

<back to all web services

ReportDefinitionVersionListRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/report/definitions/{Uid}/versions
<?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 ReportDefinitionVersion implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Id=0,
        /** @var int */
        public int $ReportDefinitionID=0,
        /** @var int */
        public int $VersionNumber=0,
        /** @var string|null */
        public ?string $DefinitionJson=null,
        /** @var string|null */
        public ?string $Status=null,
        /** @var string|null */
        public ?string $Note=null,
        /** @var string|null */
        public ?string $CreatedBy=null,
        /** @var DateTime|null */
        public ?DateTime $CreatedAt=null,
        /** @var bool|null */
        public ?bool $IsMine=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['ReportDefinitionID'])) $this->ReportDefinitionID = $o['ReportDefinitionID'];
        if (isset($o['VersionNumber'])) $this->VersionNumber = $o['VersionNumber'];
        if (isset($o['DefinitionJson'])) $this->DefinitionJson = $o['DefinitionJson'];
        if (isset($o['Status'])) $this->Status = $o['Status'];
        if (isset($o['Note'])) $this->Note = $o['Note'];
        if (isset($o['CreatedBy'])) $this->CreatedBy = $o['CreatedBy'];
        if (isset($o['CreatedAt'])) $this->CreatedAt = JsonConverters::from('DateTime', $o['CreatedAt']);
        if (isset($o['IsMine'])) $this->IsMine = $o['IsMine'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->ReportDefinitionID)) $o['ReportDefinitionID'] = $this->ReportDefinitionID;
        if (isset($this->VersionNumber)) $o['VersionNumber'] = $this->VersionNumber;
        if (isset($this->DefinitionJson)) $o['DefinitionJson'] = $this->DefinitionJson;
        if (isset($this->Status)) $o['Status'] = $this->Status;
        if (isset($this->Note)) $o['Note'] = $this->Note;
        if (isset($this->CreatedBy)) $o['CreatedBy'] = $this->CreatedBy;
        if (isset($this->CreatedAt)) $o['CreatedAt'] = JsonConverters::to('DateTime', $this->CreatedAt);
        if (isset($this->IsMine)) $o['IsMine'] = $this->IsMine;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class ReportDefinitionVersionListRequest implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $Uid=''
    ) {
    }

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

PHP ReportDefinitionVersionListRequest 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/{Uid}/versions HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReportDefinitionVersionListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Versions>
    <ReportDefinitionVersion>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <DefinitionJson>String</DefinitionJson>
      <Id>0</Id>
      <IsMine>false</IsMine>
      <Note>String</Note>
      <ReportDefinitionID>0</ReportDefinitionID>
      <Status>String</Status>
      <VersionNumber>0</VersionNumber>
    </ReportDefinitionVersion>
  </Versions>
</ReportDefinitionVersionListResponse>