Trendsic Platform Service

<back to all web services

ReportRequest

<?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 ReportResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<Object>|null */
        public ?array $ReportData=null,
        /** @var array<string>|null */
        public ?array $Filters=null
    ) {
    }

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

class ReportRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $ReportType=null,
        /** @var string|null */
        public ?string $Argument=null,
        /** @var DateTime */
        public DateTime $StartDate=new DateTime(),
        /** @var DateTime */
        public DateTime $EndDate=new DateTime(),
        /** @var string|null */
        public ?string $Filter=null,
        /** @var int */
        public int $AgentId=0,
        /** @var int */
        public int $ReportMonth=0,
        /** @var int */
        public int $ReportYear=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ReportType'])) $this->ReportType = $o['ReportType'];
        if (isset($o['Argument'])) $this->Argument = $o['Argument'];
        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['Filter'])) $this->Filter = $o['Filter'];
        if (isset($o['AgentId'])) $this->AgentId = $o['AgentId'];
        if (isset($o['ReportMonth'])) $this->ReportMonth = $o['ReportMonth'];
        if (isset($o['ReportYear'])) $this->ReportYear = $o['ReportYear'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ReportType)) $o['ReportType'] = $this->ReportType;
        if (isset($this->Argument)) $o['Argument'] = $this->Argument;
        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->Filter)) $o['Filter'] = $this->Filter;
        if (isset($this->AgentId)) $o['AgentId'] = $this->AgentId;
        if (isset($this->ReportMonth)) $o['ReportMonth'] = $this->ReportMonth;
        if (isset($this->ReportYear)) $o['ReportYear'] = $this->ReportYear;
        return empty($o) ? new class(){} : $o;
    }
}

PHP ReportRequest DTOs

GET /v1/ReportFilters/{ReportType} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<ReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Filters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Filters>
  <ReportData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType />
  </ReportData>
  <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>
</ReportResponse>