FrameAppWS

<back to all web services

DefinicionProcedimientoRQ

Requires Authentication
The following routes are available for this service:
All Verbs/Utilidades/Procedimientos/Definicion
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IdentificadoresFunciones:
    alias_funcion: Optional[str] = None
    nombre_funcion: Optional[str] = None
    descripcion: Optional[str] = None
    tipo_respuesta: Optional[str] = None
    background: Optional[str] = None
    usuario_creo: Optional[str] = None
    fecha_creacion: datetime.datetime = datetime.datetime(1, 1, 1)
    consecutivo: int = 0
    tipo_export: Optional[str] = None
    ayuda: Optional[str] = None
    endpoint: Optional[str] = None
    consume_a_p_i: Optional[str] = None
    api_rest: Optional[str] = None
    propiedad_rest: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DefinicionParametro:
    direccion: Optional[str] = None
    id_vista: Optional[Decimal] = None
    tipo_dato: Optional[str] = None
    nombre_parametro: Optional[str] = None
    alias: Optional[str] = None
    ayuda: Optional[str] = None
    datos_lookup: Optional[List[Dict[str, Object]]] = None
    campo_texto: Optional[str] = None
    campo_valor: Optional[str] = None
    version: Optional[str] = None
    obligatorio: bool = False
    valor_defecto: Optional[str] = None
    visible: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PermisosFunciones:
    codigo_sistema: Decimal = decimal.Decimal(0)
    codigo_empresa: Decimal = decimal.Decimal(0)
    alias_funcion: Optional[str] = None
    usuario: Optional[str] = None
    usuario_creo: Optional[str] = None
    fecha_creacion: datetime.datetime = datetime.datetime(1, 1, 1)
    ip: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UltimoEstado:
    codigo_ejecucion: Decimal = decimal.Decimal(0)
    estado: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DefinicionProcedimientoRS:
    procedimiento: Optional[IdentificadoresFunciones] = None
    parametros: Optional[List[DefinicionParametro]] = None
    permisos: Optional[List[PermisosFunciones]] = None
    ultimo_estado: Optional[UltimoEstado] = None
    error: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VersionLookup:
    cod_lookup: Decimal = decimal.Decimal(0)
    version: Optional[str] = None


class Lenguajes(str, Enum):
    ES = 'ES'
    PT = 'PT'
    EN = 'EN'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DefinicionProcedimientoRQ:
    consecutivo: int = 0
    versiones_lookup_cliente: Optional[List[VersionLookup]] = None
    datos_lookups: bool = False
    lenguaje: Optional[Lenguajes] = None

Python DefinicionProcedimientoRQ 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/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>