Trendsic Platform Service

<back to all web services

ReportDatasetsRequest

<?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 ReportFieldDto implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Code=null,
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $FieldKind=null,
        /** @var string|null */
        public ?string $DataType=null,
        /** @var string|null */
        public ?string $DefaultAggregation=null
    ) {
    }

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

class ReportJoinDto implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $ToDatasetCode=null,
        /** @var string|null */
        public ?string $ToDatasetName=null,
        /** @var string|null */
        public ?string $Cardinality=null,
        /** @var string|null */
        public ?string $JoinType=null
    ) {
    }

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

class ReportDatasetDto implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Code=null,
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Description=null,
        /** @var array<ReportFieldDto>|null */
        public ?array $Fields=null,
        /** @var array<ReportJoinDto>|null */
        public ?array $Joins=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Code'])) $this->Code = $o['Code'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['Fields'])) $this->Fields = JsonConverters::fromArray('ReportFieldDto', $o['Fields']);
        if (isset($o['Joins'])) $this->Joins = JsonConverters::fromArray('ReportJoinDto', $o['Joins']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Code)) $o['Code'] = $this->Code;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->Fields)) $o['Fields'] = JsonConverters::toArray('ReportFieldDto', $this->Fields);
        if (isset($this->Joins)) $o['Joins'] = JsonConverters::toArray('ReportJoinDto', $this->Joins);
        return empty($o) ? new class(){} : $o;
    }
}

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

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

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

PHP ReportDatasetsRequest DTOs

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

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

<ReportDatasetsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Datasets>
    <ReportDatasetDto>
      <Code>String</Code>
      <Description>String</Description>
      <Fields>
        <ReportFieldDto>
          <Code>String</Code>
          <DataType>String</DataType>
          <DefaultAggregation>String</DefaultAggregation>
          <FieldKind>String</FieldKind>
          <Name>String</Name>
        </ReportFieldDto>
      </Fields>
      <Joins>
        <ReportJoinDto>
          <Cardinality>String</Cardinality>
          <JoinType>String</JoinType>
          <ToDatasetCode>String</ToDatasetCode>
          <ToDatasetName>String</ToDatasetName>
        </ReportJoinDto>
      </Joins>
      <Name>String</Name>
    </ReportDatasetDto>
  </Datasets>
  <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>
</ReportDatasetsResponse>