FrameAppWS

<back to all web services

DefinicionProcedimientoRQ

Requires Authentication
The following routes are available for this service:
All Verbs/Utilidades/Procedimientos/Definicion

// @DataContract
export class IdentificadoresFunciones
{
    // @DataMember
    public AliasFuncion: string;

    // @DataMember
    public NombreFuncion: string;

    // @DataMember
    public Descripcion: string;

    // @DataMember
    public TipoRespuesta: string;

    // @DataMember
    public Background: string;

    // @DataMember
    public UsuarioCreo: string;

    // @DataMember
    public FechaCreacion: string;

    // @DataMember
    public Consecutivo: number;

    // @DataMember
    public TipoExport: string;

    // @DataMember
    public Ayuda: string;

    // @DataMember
    public Endpoint: string;

    // @DataMember
    public ConsumeAPI: string;

    // @DataMember
    public APIRest: string;

    // @DataMember
    public PropiedadRest: string;

    public constructor(init?: Partial<IdentificadoresFunciones>) { (Object as any).assign(this, init); }
}

export class DefinicionParametro
{
    public Direccion: string;
    public IdVista?: number;
    public TipoDato: string;
    public NombreParametro: string;
    public Alias: string;
    public Ayuda: string;
    public DatosLookup: { [index:string]: Object; }[];
    public CampoTexto: string;
    public CampoValor: string;
    public Version: string;
    public Obligatorio: boolean;
    public ValorDefecto: string;
    public Visible: boolean;

    public constructor(init?: Partial<DefinicionParametro>) { (Object as any).assign(this, init); }
}

// @DataContract
export class PermisosFunciones
{
    // @DataMember
    public CodigoSistema: number;

    // @DataMember
    public CodigoEmpresa: number;

    // @DataMember
    public AliasFuncion: string;

    // @DataMember
    public Usuario: string;

    // @DataMember
    public UsuarioCreo: string;

    // @DataMember
    public FechaCreacion: string;

    // @DataMember
    public IP: string;

    public constructor(init?: Partial<PermisosFunciones>) { (Object as any).assign(this, init); }
}

export class UltimoEstado
{
    public CodigoEjecucion: number;
    public Estado: string;

    public constructor(init?: Partial<UltimoEstado>) { (Object as any).assign(this, init); }
}

export class DefinicionProcedimientoRS
{
    public Procedimiento: IdentificadoresFunciones;
    public Parametros: DefinicionParametro[];
    public Permisos: PermisosFunciones[];
    public UltimoEstado: UltimoEstado;
    public Error: string;

    public constructor(init?: Partial<DefinicionProcedimientoRS>) { (Object as any).assign(this, init); }
}

export class VersionLookup
{
    public CodLookup: number;
    public Version: string;

    public constructor(init?: Partial<VersionLookup>) { (Object as any).assign(this, init); }
}

export enum Lenguajes
{
    ES = 'ES',
    PT = 'PT',
    EN = 'EN',
}

export class DefinicionProcedimientoRQ
{
    public Consecutivo: number;
    public VersionesLookupCliente: VersionLookup[];
    public DatosLookups: boolean;
    public Lenguaje: Lenguajes;

    public constructor(init?: Partial<DefinicionProcedimientoRQ>) { (Object as any).assign(this, init); }
}

TypeScript 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: soluser-recaudo.sgsas.co 
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,
		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,
			IP: String
		}
	],
	UltimoEstado: 
	{
		CodigoEjecucion: 0,
		Estado: String
	},
	Error: String
}