digitaluapi

<back to all web services

GetQueryResults

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/scadmeta/tables/query/{QueryId}
<?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 GetQueryResults implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $QueryId=0,
        /** @var array<string,Object>|null */
        public ?array $ParameterList=null,
        /** @var Paging|null */
        public ?Paging $Paging=null
    ) {
    }

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

PHP GetQueryResults 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 /scadmeta/tables/query/{QueryId} 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>