FrameAppWS

<back to all web services

EjecutaQueryBackRQ

Requires Authentication
The following routes are available for this service:
All Verbs/Utilidades/Consultas/Listados/EjecucionBackground
<?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 EjecutaQueryBackgroundRS implements JsonSerializable
{
    public function __construct(
        /** @var float */
        public float $Empresa=0.0,
        /** @var float */
        public float $Sistema=0.0,
        /** @var string|null */
        public ?string $Login=null,
        /** @var bool|null */
        public ?bool $AppAdm=null,
        /** @var string|null */
        public ?string $TxtSQL=null,
        /** @var string|null */
        public ?string $URLArchivo=null,
        /** @var bool|null */
        public ?bool $Success=null,
        /** @var string|null */
        public ?string $Error=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Empresa'])) $this->Empresa = $o['Empresa'];
        if (isset($o['Sistema'])) $this->Sistema = $o['Sistema'];
        if (isset($o['Login'])) $this->Login = $o['Login'];
        if (isset($o['AppAdm'])) $this->AppAdm = $o['AppAdm'];
        if (isset($o['TxtSQL'])) $this->TxtSQL = $o['TxtSQL'];
        if (isset($o['URLArchivo'])) $this->URLArchivo = $o['URLArchivo'];
        if (isset($o['Success'])) $this->Success = $o['Success'];
        if (isset($o['Error'])) $this->Error = $o['Error'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Empresa)) $o['Empresa'] = $this->Empresa;
        if (isset($this->Sistema)) $o['Sistema'] = $this->Sistema;
        if (isset($this->Login)) $o['Login'] = $this->Login;
        if (isset($this->AppAdm)) $o['AppAdm'] = $this->AppAdm;
        if (isset($this->TxtSQL)) $o['TxtSQL'] = $this->TxtSQL;
        if (isset($this->URLArchivo)) $o['URLArchivo'] = $this->URLArchivo;
        if (isset($this->Success)) $o['Success'] = $this->Success;
        if (isset($this->Error)) $o['Error'] = $this->Error;
        return empty($o) ? new class(){} : $o;
    }
}

enum Lenguajes : string
{
    case ES = 'ES';
    case PT = 'PT';
    case EN = 'EN';
}

class gridSortOptions implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $selector=null,
        /** @var bool|null */
        public ?bool $desc=null
    ) {
    }

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

class gridGroupOptions implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $selector=null,
        /** @var bool|null */
        public ?bool $desc=null,
        /** @var bool|null */
        public ?bool $isExpanded=null
    ) {
    }

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

class EjecutaQueryBackRQ implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $IDVista=0,
        /** @var bool|null */
        public ?bool $DatosDetalles=null,
        /** @var array<string,Object>|null */
        public ?array $Parametros=null,
        /** @var Lenguajes|null */
        public ?Lenguajes $Lenguaje=null,
        /** @var int */
        public int $RecordSkip=0,
        /** @var int */
        public int $RecordTake=0,
        /** @var array<Object>|null */
        public ?array $Filter=null,
        /** @var gridSortOptions|null */
        public ?gridSortOptions $Sort=null,
        /** @var gridGroupOptions|null */
        public ?gridGroupOptions $Group=null,
        /** @var gridSummaryOptions[]|null */
        public ?array $SummaryGroupItems=null,
        /** @var gridSummaryOptions[]|null */
        public ?array $SummaryTotalItems=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['IDVista'])) $this->IDVista = $o['IDVista'];
        if (isset($o['DatosDetalles'])) $this->DatosDetalles = $o['DatosDetalles'];
        if (isset($o['Parametros'])) $this->Parametros = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','Object']), $o['Parametros']);
        if (isset($o['Lenguaje'])) $this->Lenguaje = JsonConverters::from('Lenguajes', $o['Lenguaje']);
        if (isset($o['RecordSkip'])) $this->RecordSkip = $o['RecordSkip'];
        if (isset($o['RecordTake'])) $this->RecordTake = $o['RecordTake'];
        if (isset($o['Filter'])) $this->Filter = JsonConverters::fromArray('Object', $o['Filter']);
        if (isset($o['Sort'])) $this->Sort = JsonConverters::from('gridSortOptions', $o['Sort']);
        if (isset($o['Group'])) $this->Group = JsonConverters::from('gridGroupOptions', $o['Group']);
        if (isset($o['SummaryGroupItems'])) $this->SummaryGroupItems = JsonConverters::fromArray('gridSummaryOptions', $o['SummaryGroupItems']);
        if (isset($o['SummaryTotalItems'])) $this->SummaryTotalItems = JsonConverters::fromArray('gridSummaryOptions', $o['SummaryTotalItems']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->IDVista)) $o['IDVista'] = $this->IDVista;
        if (isset($this->DatosDetalles)) $o['DatosDetalles'] = $this->DatosDetalles;
        if (isset($this->Parametros)) $o['Parametros'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','Object']), $this->Parametros);
        if (isset($this->Lenguaje)) $o['Lenguaje'] = JsonConverters::to('Lenguajes', $this->Lenguaje);
        if (isset($this->RecordSkip)) $o['RecordSkip'] = $this->RecordSkip;
        if (isset($this->RecordTake)) $o['RecordTake'] = $this->RecordTake;
        if (isset($this->Filter)) $o['Filter'] = JsonConverters::toArray('Object', $this->Filter);
        if (isset($this->Sort)) $o['Sort'] = JsonConverters::to('gridSortOptions', $this->Sort);
        if (isset($this->Group)) $o['Group'] = JsonConverters::to('gridGroupOptions', $this->Group);
        if (isset($this->SummaryGroupItems)) $o['SummaryGroupItems'] = JsonConverters::toArray('gridSummaryOptions', $this->SummaryGroupItems);
        if (isset($this->SummaryTotalItems)) $o['SummaryTotalItems'] = JsonConverters::toArray('gridSummaryOptions', $this->SummaryTotalItems);
        return empty($o) ? new class(){} : $o;
    }
}

class gridSummaryOptions implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $selector=null,
        /** @var string|null */
        public ?string $summaryType=null
    ) {
    }

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

PHP EjecutaQueryBackRQ 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.

POST /Utilidades/Consultas/Listados/EjecucionBackground HTTP/1.1 
Host: soluser-recaudo.sgsas.co 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EjecutaQueryBackRQ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Administrador.Modelo.Tipos">
  <DatosDetalles>false</DatosDetalles>
  <Filter xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType />
  </Filter>
  <Group xmlns:d2p1="http://schemas.datacontract.org/2004/07/Administrador.Modelo.DevExtreme">
    <d2p1:desc>false</d2p1:desc>
    <d2p1:isExpanded>false</d2p1:isExpanded>
    <d2p1:selector>String</d2p1:selector>
  </Group>
  <IDVista>0</IDVista>
  <Lenguaje>ES</Lenguaje>
  <Parametros xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </Parametros>
  <RecordSkip>0</RecordSkip>
  <RecordTake>0</RecordTake>
  <Sort xmlns:d2p1="http://schemas.datacontract.org/2004/07/Administrador.Modelo.DevExtreme">
    <d2p1:desc>false</d2p1:desc>
    <d2p1:selector>String</d2p1:selector>
  </Sort>
  <SummaryGroupItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/Administrador.Modelo.DevExtreme">
    <d2p1:gridSummaryOptions>
      <d2p1:selector>String</d2p1:selector>
      <d2p1:summaryType>String</d2p1:summaryType>
    </d2p1:gridSummaryOptions>
  </SummaryGroupItems>
  <SummaryTotalItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/Administrador.Modelo.DevExtreme">
    <d2p1:gridSummaryOptions>
      <d2p1:selector>String</d2p1:selector>
      <d2p1:summaryType>String</d2p1:summaryType>
    </d2p1:gridSummaryOptions>
  </SummaryTotalItems>
</EjecutaQueryBackRQ>

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

<EjecutaQueryBackgroundRS xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Administrador.Modelo.Tipos">
  <AppAdm>false</AppAdm>
  <Empresa>0</Empresa>
  <Error>String</Error>
  <Login>String</Login>
  <Sistema>0</Sistema>
  <Success>false</Success>
  <TxtSQL>String</TxtSQL>
  <URLArchivo>String</URLArchivo>
</EjecutaQueryBackgroundRS>