FrameAppWS

DefinicionProcedimientoRQ

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: Optional[datetime.datetime] = None
    consecutivo: Optional[int] = None
    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: Optional[bool] = None
    valor_defecto: Optional[str] = None
    visible: Optional[bool] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UltimoEstado:
    codigo_ejecucion: Optional[Decimal] = None
    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: Optional[Decimal] = None
    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: Optional[int] = None
    versiones_lookup_cliente: Optional[List[VersionLookup]] = None
    datos_lookups: Optional[bool] = None
    lenguaje: Optional[Lenguajes] = None

Python DefinicionProcedimientoRQ DTOs

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

HTTP + JSV

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: ws.jimsnwa.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Procedimiento: 
	{
		AliasFuncion: String,
		NombreFuncion: String,
		Descripcion: String,
		TipoRespuesta: String,
		Background: String,
		UsuarioCreo: String,
		FechaCreacion: 0001-01-01,
		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: 0001-01-01,
			IP: String
		}
	],
	UltimoEstado: 
	{
		CodigoEjecucion: 0,
		Estado: String
	},
	Error: String
}