digitaluapi

<back to all web services

GetTableColumnsRequest

<?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 Paging implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $PageNumber=0,
        /** @var int */
        public int $PageSize=0
    ) {
    }

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

class GetTableColumnsRequest implements JsonSerializable
{
    public function __construct(
        /** @description Table id */
        // @ApiMember(Description="Table id", IsRequired=true)
        /** @var int */
        public int $TablesId=0,

        /** @description Parameter list */
        // @ApiMember(Description="Parameter list")
        /** @var array<string,Object>|null */
        public ?array $ParameterList=null,

        /** @description Filter list */
        // @ApiMember(Description="Filter list")
        /** @var array<string,Object>|null */
        public ?array $FilterList=null,

        /** @description Number of items to be returned per page */
        // @ApiMember(Description="Number of items to be returned per page")
        /** @var Paging|null */
        public ?Paging $Paging=null,

        /** @var int */
        public int $FromId=0,
        /** @description Drill down filter list */
        // @ApiMember(Description="Drill down filter list")
        /** @var array<string,Object>|null */
        public ?array $DrillDownFilterList=null,

        /** @description Global parameter list */
        // @ApiMember(Description="Global parameter list")
        /** @var array<string,Object>|null */
        public ?array $GlobalParamList=null,

        /** @description View id */
        // @ApiMember(Description="View id")
        /** @var int|null */
        public ?int $ViewId=null,

        /** @description Whether or not to refresh the cache */
        // @ApiMember(Description="Whether or not to refresh the cache")
        /** @var bool|null */
        public ?bool $RefreshCache=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['TablesId'])) $this->TablesId = $o['TablesId'];
        if (isset($o['ParameterList'])) $this->ParameterList = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','Object']), $o['ParameterList']);
        if (isset($o['FilterList'])) $this->FilterList = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','Object']), $o['FilterList']);
        if (isset($o['Paging'])) $this->Paging = JsonConverters::from('Paging', $o['Paging']);
        if (isset($o['FromId'])) $this->FromId = $o['FromId'];
        if (isset($o['DrillDownFilterList'])) $this->DrillDownFilterList = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','Object']), $o['DrillDownFilterList']);
        if (isset($o['GlobalParamList'])) $this->GlobalParamList = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','Object']), $o['GlobalParamList']);
        if (isset($o['ViewId'])) $this->ViewId = $o['ViewId'];
        if (isset($o['RefreshCache'])) $this->RefreshCache = $o['RefreshCache'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->TablesId)) $o['TablesId'] = $this->TablesId;
        if (isset($this->ParameterList)) $o['ParameterList'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','Object']), $this->ParameterList);
        if (isset($this->FilterList)) $o['FilterList'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','Object']), $this->FilterList);
        if (isset($this->Paging)) $o['Paging'] = JsonConverters::to('Paging', $this->Paging);
        if (isset($this->FromId)) $o['FromId'] = $this->FromId;
        if (isset($this->DrillDownFilterList)) $o['DrillDownFilterList'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','Object']), $this->DrillDownFilterList);
        if (isset($this->GlobalParamList)) $o['GlobalParamList'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','Object']), $this->GlobalParamList);
        if (isset($this->ViewId)) $o['ViewId'] = $this->ViewId;
        if (isset($this->RefreshCache)) $o['RefreshCache'] = $this->RefreshCache;
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetTableColumnsRequest DTOs

GET /scadmeta/tables/{TablesId}/columns HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml

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

<ArrayOfanyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <anyType />
</ArrayOfanyType>