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 .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: ws.jimsnwa.com 
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>