FrameAppWS

<back to all web services

DefinicionProcedimientoRQ

Requires Authentication
The following routes are available for this service:
All Verbs/Utilidades/Procedimientos/Definicion
<?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};


// @DataContract
class IdentificadoresFunciones implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var string|null */
        public ?string $AliasFuncion=null,

        // @DataMember
        /** @var string|null */
        public ?string $NombreFuncion=null,

        // @DataMember
        /** @var string|null */
        public ?string $Descripcion=null,

        // @DataMember
        /** @var string|null */
        public ?string $TipoRespuesta=null,

        // @DataMember
        /** @var string|null */
        public ?string $Background=null,

        // @DataMember
        /** @var string|null */
        public ?string $UsuarioCreo=null,

        // @DataMember
        /** @var DateTime */
        public DateTime $FechaCreacion=new DateTime(),

        // @DataMember
        /** @var int */
        public int $Consecutivo=0,

        // @DataMember
        /** @var string|null */
        public ?string $TipoExport=null,

        // @DataMember
        /** @var string|null */
        public ?string $Ayuda=null,

        // @DataMember
        /** @var string|null */
        public ?string $Endpoint=null,

        // @DataMember
        /** @var string|null */
        public ?string $ConsumeAPI=null,

        // @DataMember
        /** @var string|null */
        public ?string $APIRest=null,

        // @DataMember
        /** @var string|null */
        public ?string $PropiedadRest=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['AliasFuncion'])) $this->AliasFuncion = $o['AliasFuncion'];
        if (isset($o['NombreFuncion'])) $this->NombreFuncion = $o['NombreFuncion'];
        if (isset($o['Descripcion'])) $this->Descripcion = $o['Descripcion'];
        if (isset($o['TipoRespuesta'])) $this->TipoRespuesta = $o['TipoRespuesta'];
        if (isset($o['Background'])) $this->Background = $o['Background'];
        if (isset($o['UsuarioCreo'])) $this->UsuarioCreo = $o['UsuarioCreo'];
        if (isset($o['FechaCreacion'])) $this->FechaCreacion = JsonConverters::from('DateTime', $o['FechaCreacion']);
        if (isset($o['Consecutivo'])) $this->Consecutivo = $o['Consecutivo'];
        if (isset($o['TipoExport'])) $this->TipoExport = $o['TipoExport'];
        if (isset($o['Ayuda'])) $this->Ayuda = $o['Ayuda'];
        if (isset($o['Endpoint'])) $this->Endpoint = $o['Endpoint'];
        if (isset($o['ConsumeAPI'])) $this->ConsumeAPI = $o['ConsumeAPI'];
        if (isset($o['APIRest'])) $this->APIRest = $o['APIRest'];
        if (isset($o['PropiedadRest'])) $this->PropiedadRest = $o['PropiedadRest'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->AliasFuncion)) $o['AliasFuncion'] = $this->AliasFuncion;
        if (isset($this->NombreFuncion)) $o['NombreFuncion'] = $this->NombreFuncion;
        if (isset($this->Descripcion)) $o['Descripcion'] = $this->Descripcion;
        if (isset($this->TipoRespuesta)) $o['TipoRespuesta'] = $this->TipoRespuesta;
        if (isset($this->Background)) $o['Background'] = $this->Background;
        if (isset($this->UsuarioCreo)) $o['UsuarioCreo'] = $this->UsuarioCreo;
        if (isset($this->FechaCreacion)) $o['FechaCreacion'] = JsonConverters::to('DateTime', $this->FechaCreacion);
        if (isset($this->Consecutivo)) $o['Consecutivo'] = $this->Consecutivo;
        if (isset($this->TipoExport)) $o['TipoExport'] = $this->TipoExport;
        if (isset($this->Ayuda)) $o['Ayuda'] = $this->Ayuda;
        if (isset($this->Endpoint)) $o['Endpoint'] = $this->Endpoint;
        if (isset($this->ConsumeAPI)) $o['ConsumeAPI'] = $this->ConsumeAPI;
        if (isset($this->APIRest)) $o['APIRest'] = $this->APIRest;
        if (isset($this->PropiedadRest)) $o['PropiedadRest'] = $this->PropiedadRest;
        return empty($o) ? new class(){} : $o;
    }
}

class DefinicionParametro implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Direccion=null,
        /** @var float|null */
        public ?float $IdVista=null,
        /** @var string|null */
        public ?string $TipoDato=null,
        /** @var string|null */
        public ?string $NombreParametro=null,
        /** @var string|null */
        public ?string $Alias=null,
        /** @var string|null */
        public ?string $Ayuda=null,
        /** @var array<array<string,Object>>|null */
        public ?array $DatosLookup=null,
        /** @var string|null */
        public ?string $CampoTexto=null,
        /** @var string|null */
        public ?string $CampoValor=null,
        /** @var string|null */
        public ?string $Version=null,
        /** @var bool|null */
        public ?bool $Obligatorio=null,
        /** @var string|null */
        public ?string $ValorDefecto=null,
        /** @var bool|null */
        public ?bool $Visible=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Direccion'])) $this->Direccion = $o['Direccion'];
        if (isset($o['IdVista'])) $this->IdVista = $o['IdVista'];
        if (isset($o['TipoDato'])) $this->TipoDato = $o['TipoDato'];
        if (isset($o['NombreParametro'])) $this->NombreParametro = $o['NombreParametro'];
        if (isset($o['Alias'])) $this->Alias = $o['Alias'];
        if (isset($o['Ayuda'])) $this->Ayuda = $o['Ayuda'];
        if (isset($o['DatosLookup'])) $this->DatosLookup = JsonConverters::fromArray('Dictionary<String,Object>', $o['DatosLookup']);
        if (isset($o['CampoTexto'])) $this->CampoTexto = $o['CampoTexto'];
        if (isset($o['CampoValor'])) $this->CampoValor = $o['CampoValor'];
        if (isset($o['Version'])) $this->Version = $o['Version'];
        if (isset($o['Obligatorio'])) $this->Obligatorio = $o['Obligatorio'];
        if (isset($o['ValorDefecto'])) $this->ValorDefecto = $o['ValorDefecto'];
        if (isset($o['Visible'])) $this->Visible = $o['Visible'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Direccion)) $o['Direccion'] = $this->Direccion;
        if (isset($this->IdVista)) $o['IdVista'] = $this->IdVista;
        if (isset($this->TipoDato)) $o['TipoDato'] = $this->TipoDato;
        if (isset($this->NombreParametro)) $o['NombreParametro'] = $this->NombreParametro;
        if (isset($this->Alias)) $o['Alias'] = $this->Alias;
        if (isset($this->Ayuda)) $o['Ayuda'] = $this->Ayuda;
        if (isset($this->DatosLookup)) $o['DatosLookup'] = JsonConverters::toArray('Dictionary<String,Object>', $this->DatosLookup);
        if (isset($this->CampoTexto)) $o['CampoTexto'] = $this->CampoTexto;
        if (isset($this->CampoValor)) $o['CampoValor'] = $this->CampoValor;
        if (isset($this->Version)) $o['Version'] = $this->Version;
        if (isset($this->Obligatorio)) $o['Obligatorio'] = $this->Obligatorio;
        if (isset($this->ValorDefecto)) $o['ValorDefecto'] = $this->ValorDefecto;
        if (isset($this->Visible)) $o['Visible'] = $this->Visible;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class PermisosFunciones implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var float */
        public float $CodigoSistema=0.0,

        // @DataMember
        /** @var float */
        public float $CodigoEmpresa=0.0,

        // @DataMember
        /** @var string|null */
        public ?string $AliasFuncion=null,

        // @DataMember
        /** @var string|null */
        public ?string $Usuario=null,

        // @DataMember
        /** @var string|null */
        public ?string $UsuarioCreo=null,

        // @DataMember
        /** @var DateTime */
        public DateTime $FechaCreacion=new DateTime(),

        // @DataMember
        /** @var string|null */
        public ?string $IP=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CodigoSistema'])) $this->CodigoSistema = $o['CodigoSistema'];
        if (isset($o['CodigoEmpresa'])) $this->CodigoEmpresa = $o['CodigoEmpresa'];
        if (isset($o['AliasFuncion'])) $this->AliasFuncion = $o['AliasFuncion'];
        if (isset($o['Usuario'])) $this->Usuario = $o['Usuario'];
        if (isset($o['UsuarioCreo'])) $this->UsuarioCreo = $o['UsuarioCreo'];
        if (isset($o['FechaCreacion'])) $this->FechaCreacion = JsonConverters::from('DateTime', $o['FechaCreacion']);
        if (isset($o['IP'])) $this->IP = $o['IP'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CodigoSistema)) $o['CodigoSistema'] = $this->CodigoSistema;
        if (isset($this->CodigoEmpresa)) $o['CodigoEmpresa'] = $this->CodigoEmpresa;
        if (isset($this->AliasFuncion)) $o['AliasFuncion'] = $this->AliasFuncion;
        if (isset($this->Usuario)) $o['Usuario'] = $this->Usuario;
        if (isset($this->UsuarioCreo)) $o['UsuarioCreo'] = $this->UsuarioCreo;
        if (isset($this->FechaCreacion)) $o['FechaCreacion'] = JsonConverters::to('DateTime', $this->FechaCreacion);
        if (isset($this->IP)) $o['IP'] = $this->IP;
        return empty($o) ? new class(){} : $o;
    }
}

class UltimoEstado implements JsonSerializable
{
    public function __construct(
        /** @var float */
        public float $CodigoEjecucion=0.0,
        /** @var string|null */
        public ?string $Estado=null
    ) {
    }

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

class DefinicionProcedimientoRS implements JsonSerializable
{
    public function __construct(
        /** @var IdentificadoresFunciones|null */
        public ?IdentificadoresFunciones $Procedimiento=null,
        /** @var array<DefinicionParametro>|null */
        public ?array $Parametros=null,
        /** @var array<PermisosFunciones>|null */
        public ?array $Permisos=null,
        /** @var UltimoEstado|null */
        public ?UltimoEstado $UltimoEstado=null,
        /** @var string|null */
        public ?string $Error=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Procedimiento'])) $this->Procedimiento = JsonConverters::from('IdentificadoresFunciones', $o['Procedimiento']);
        if (isset($o['Parametros'])) $this->Parametros = JsonConverters::fromArray('DefinicionParametro', $o['Parametros']);
        if (isset($o['Permisos'])) $this->Permisos = JsonConverters::fromArray('PermisosFunciones', $o['Permisos']);
        if (isset($o['UltimoEstado'])) $this->UltimoEstado = JsonConverters::from('UltimoEstado', $o['UltimoEstado']);
        if (isset($o['Error'])) $this->Error = $o['Error'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Procedimiento)) $o['Procedimiento'] = JsonConverters::to('IdentificadoresFunciones', $this->Procedimiento);
        if (isset($this->Parametros)) $o['Parametros'] = JsonConverters::toArray('DefinicionParametro', $this->Parametros);
        if (isset($this->Permisos)) $o['Permisos'] = JsonConverters::toArray('PermisosFunciones', $this->Permisos);
        if (isset($this->UltimoEstado)) $o['UltimoEstado'] = JsonConverters::to('UltimoEstado', $this->UltimoEstado);
        if (isset($this->Error)) $o['Error'] = $this->Error;
        return empty($o) ? new class(){} : $o;
    }
}

class VersionLookup implements JsonSerializable
{
    public function __construct(
        /** @var float */
        public float $CodLookup=0.0,
        /** @var string|null */
        public ?string $Version=null
    ) {
    }

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

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

class DefinicionProcedimientoRQ implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Consecutivo=0,
        /** @var array<VersionLookup>|null */
        public ?array $VersionesLookupCliente=null,
        /** @var bool|null */
        public ?bool $DatosLookups=null,
        /** @var Lenguajes|null */
        public ?Lenguajes $Lenguaje=null
    ) {
    }

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

PHP DefinicionProcedimientoRQ DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Utilidades/Procedimientos/Definicion HTTP/1.1 
Host: soluser-recaudo.sgsas.co 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Consecutivo":0,"VersionesLookupCliente":[{"CodLookup":0,"Version":"String"}],"DatosLookups":false,"Lenguaje":"ES"}

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

{"Procedimiento":{"AliasFuncion":"String","NombreFuncion":"String","Descripcion":"String","TipoRespuesta":"String","Background":"String","UsuarioCreo":"String","FechaCreacion":null,"Consecutivo":0,"TipoExport":"String","Ayuda":"String","Endpoint":"String","ConsumeAPI":"String","APIRest":"String","PropiedadRest":"String"},"Parametros":[{"Direccion":"String","IdVista":0,"TipoDato":"String","NombreParametro":"String","Alias":"String","Ayuda":"String","DatosLookup":[{"String":{}}],"CampoTexto":"String","CampoValor":"String","Version":"String","Obligatorio":false,"ValorDefecto":"String","Visible":false}],"Permisos":[{"CodigoSistema":0,"CodigoEmpresa":0,"AliasFuncion":"String","Usuario":"String","UsuarioCreo":"String","FechaCreacion":null,"IP":"String"}],"UltimoEstado":{"CodigoEjecucion":0,"Estado":"String"},"Error":"String"}