FrameAppWS

<back to all web services

DefinicionProcedimientoRQ

"use strict";
export class IdentificadoresFunciones {
    /** @param {{AliasFuncion?:string,NombreFuncion?:string,Descripcion?:string,TipoRespuesta?:string,Background?:string,UsuarioCreo?:string,FechaCreacion?:string,Consecutivo?:number,TipoExport?:string,Ayuda?:string,Endpoint?:string,ConsumeAPI?:string,APIRest?:string,PropiedadRest?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    AliasFuncion;
    /** @type {string} */
    NombreFuncion;
    /** @type {string} */
    Descripcion;
    /** @type {string} */
    TipoRespuesta;
    /** @type {string} */
    Background;
    /** @type {string} */
    UsuarioCreo;
    /** @type {string} */
    FechaCreacion;
    /** @type {number} */
    Consecutivo;
    /** @type {string} */
    TipoExport;
    /** @type {string} */
    Ayuda;
    /** @type {string} */
    Endpoint;
    /** @type {string} */
    ConsumeAPI;
    /** @type {string} */
    APIRest;
    /** @type {string} */
    PropiedadRest;
}
export class DefinicionParametro {
    /** @param {{Direccion?:string,IdVista?:number,TipoDato?:string,NombreParametro?:string,Alias?:string,Ayuda?:string,DatosLookup?:{ [index:string]: Object; }[],CampoTexto?:string,CampoValor?:string,Version?:string,Obligatorio?:boolean,ValorDefecto?:string,Visible?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Direccion;
    /** @type {?number} */
    IdVista;
    /** @type {string} */
    TipoDato;
    /** @type {string} */
    NombreParametro;
    /** @type {string} */
    Alias;
    /** @type {string} */
    Ayuda;
    /** @type {{ [index:string]: Object; }[]} */
    DatosLookup;
    /** @type {string} */
    CampoTexto;
    /** @type {string} */
    CampoValor;
    /** @type {string} */
    Version;
    /** @type {boolean} */
    Obligatorio;
    /** @type {string} */
    ValorDefecto;
    /** @type {boolean} */
    Visible;
}
export class PermisosFunciones {
    /** @param {{CodigoSistema?:number,CodigoEmpresa?:number,AliasFuncion?:string,Usuario?:string,UsuarioCreo?:string,FechaCreacion?:string,IP?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CodigoSistema;
    /** @type {number} */
    CodigoEmpresa;
    /** @type {string} */
    AliasFuncion;
    /** @type {string} */
    Usuario;
    /** @type {string} */
    UsuarioCreo;
    /** @type {string} */
    FechaCreacion;
    /** @type {string} */
    IP;
}
export class UltimoEstado {
    /** @param {{CodigoEjecucion?:number,Estado?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CodigoEjecucion;
    /** @type {string} */
    Estado;
}
export class DefinicionProcedimientoRS {
    /** @param {{Procedimiento?:IdentificadoresFunciones,Parametros?:DefinicionParametro[],Permisos?:PermisosFunciones[],UltimoEstado?:UltimoEstado,Error?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {IdentificadoresFunciones} */
    Procedimiento;
    /** @type {DefinicionParametro[]} */
    Parametros;
    /** @type {PermisosFunciones[]} */
    Permisos;
    /** @type {UltimoEstado} */
    UltimoEstado;
    /** @type {string} */
    Error;
}
export class VersionLookup {
    /** @param {{CodLookup?:number,Version?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CodLookup;
    /** @type {string} */
    Version;
}
/** @typedef {'ES'|'PT'|'EN'} */
export var Lenguajes;
(function (Lenguajes) {
    Lenguajes["ES"] = "ES"
    Lenguajes["PT"] = "PT"
    Lenguajes["EN"] = "EN"
})(Lenguajes || (Lenguajes = {}));
export class DefinicionProcedimientoRQ {
    /** @param {{Consecutivo?:number,VersionesLookupCliente?:VersionLookup[],DatosLookups?:boolean,Lenguaje?:Lenguajes}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Consecutivo;
    /** @type {VersionLookup[]} */
    VersionesLookupCliente;
    /** @type {boolean} */
    DatosLookups;
    /** @type {Lenguajes} */
    Lenguaje;
}

JavaScript DefinicionProcedimientoRQ DTOs

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

<DefinicionProcedimientoRQ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Administrador.Modelo.Tipos">
  <Consecutivo>0</Consecutivo>
  <DatosLookups>false</DatosLookups>
  <Lenguaje>ES</Lenguaje>
  <VersionesLookupCliente>
    <VersionLookup>
      <CodLookup>0</CodLookup>
      <Version>String</Version>
    </VersionLookup>
  </VersionesLookupCliente>
</DefinicionProcedimientoRQ>

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

<DefinicionProcedimientoRS xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Administrador.Modelo.Tipos">
  <Error>String</Error>
  <Parametros>
    <DefinicionParametro>
      <Alias>String</Alias>
      <Ayuda>String</Ayuda>
      <CampoTexto>String</CampoTexto>
      <CampoValor>String</CampoValor>
      <DatosLookup xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:ArrayOfKeyValueOfstringanyType>
          <d4p1:KeyValueOfstringanyType>
            <d4p1:Key>String</d4p1:Key>
            <d4p1:Value />
          </d4p1:KeyValueOfstringanyType>
        </d4p1:ArrayOfKeyValueOfstringanyType>
      </DatosLookup>
      <Direccion>String</Direccion>
      <IdVista>0</IdVista>
      <NombreParametro>String</NombreParametro>
      <Obligatorio>false</Obligatorio>
      <TipoDato>String</TipoDato>
      <ValorDefecto>String</ValorDefecto>
      <Version>String</Version>
      <Visible>false</Visible>
    </DefinicionParametro>
  </Parametros>
  <Permisos xmlns:d2p1="http://schemas.datacontract.org/2004/07/Administrador.Modelo.Contexto">
    <d2p1:PermisosFunciones>
      <d2p1:AliasFuncion>String</d2p1:AliasFuncion>
      <d2p1:CodigoEmpresa>0</d2p1:CodigoEmpresa>
      <d2p1:CodigoSistema>0</d2p1:CodigoSistema>
      <d2p1:FechaCreacion>0001-01-01T00:00:00</d2p1:FechaCreacion>
      <d2p1:IP>String</d2p1:IP>
      <d2p1:Usuario>String</d2p1:Usuario>
      <d2p1:UsuarioCreo>String</d2p1:UsuarioCreo>
    </d2p1:PermisosFunciones>
  </Permisos>
  <Procedimiento xmlns:d2p1="http://schemas.datacontract.org/2004/07/Administrador.Modelo.Contexto">
    <d2p1:APIRest>String</d2p1:APIRest>
    <d2p1:AliasFuncion>String</d2p1:AliasFuncion>
    <d2p1:Ayuda>String</d2p1:Ayuda>
    <d2p1:Background>String</d2p1:Background>
    <d2p1:Consecutivo>0</d2p1:Consecutivo>
    <d2p1:ConsumeAPI>String</d2p1:ConsumeAPI>
    <d2p1:Descripcion>String</d2p1:Descripcion>
    <d2p1:Endpoint>String</d2p1:Endpoint>
    <d2p1:FechaCreacion>0001-01-01T00:00:00</d2p1:FechaCreacion>
    <d2p1:NombreFuncion>String</d2p1:NombreFuncion>
    <d2p1:PropiedadRest>String</d2p1:PropiedadRest>
    <d2p1:TipoExport>String</d2p1:TipoExport>
    <d2p1:TipoRespuesta>String</d2p1:TipoRespuesta>
    <d2p1:UsuarioCreo>String</d2p1:UsuarioCreo>
  </Procedimiento>
  <UltimoEstado>
    <CodigoEjecucion>0</CodigoEjecucion>
    <Estado>String</Estado>
  </UltimoEstado>
</DefinicionProcedimientoRS>