Documento de API

Considerações Gerais

Objetivo

Retornar os dados referente aos filtros que serão aplicados na carga da integração com a Softsite..

Funcionamento

Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias.

A sintaxe para a chamada da API é:

run fch/fchdis/fchdis0029b.p

A sintaxe para executar a API em modo persistente é:

run fch/fchdis/fchdis0029b.p persistent set h-handle.

A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.

Nos atributos das tabelas temporárias de entrada e saída:

ttRepresSource					Entrada/Saída
Representantes disponíveis no filtro.					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
codigo	char	-	Código.	Sim	-
nivAces	char	-	Nivel acesso.	Sim	-
descr	char	-	Nome.	Sim	-

ttRepresTarget					Entrada/Saída
Representantes selecionados no filtro.					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
codigo	char	-	Código.	Sim	-
nivAces	char	-	Nivel acesso.	Sim	-
descr	char	-	Nome.	Sim	-

ttEstabSource					Entrada/Saída
Representantes selecionados no filtro.					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
codigo	char	-	Código.	Sim	-
descr	char	-	Nome.	Sim	-

ttEstabTarget					Entrada/Saída
Estabelecimentos selecionados no filtro.					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
codigo	char	-	Código.	Sim	-
descr	char	-	Nome.	Sim	-

ttTabPrecoSource					Entrada/Saída
Tabelas de preço disponíveis no filtro.					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
codigo	char	-	Código.	Sim	-
descr	char	-	Nome.	Sim	-

ttTabPrecoTarget					Entrada/Saída
Tabelas de preços selecionadas no filtro.					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
codigo	char	-	Código.	Sim	-
descr	char	-	Nome.	Sim	-

ttCondPagtoSource					Entrada/Saída
Condições de pagamento disponíveis no filtro.					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
codigo	char	-	Código.	Sim	-
descr	char	-	Nome.	Sim	-

ttCondPagtoTarget					Entrada/Saída
Condições de pagamento selecionadas no filtro.					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
codigo	char	-	Código.	Sim	-
descr	char	-	Nome.	Sim	-

Quando a API for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

returnFilterData
Requisito	Nenhum
Sintaxe	-
Descrição	Retornar os dados referentes aos filtros que serão aplicados na carga da integração com a Softsite.
	Parâmetros	Descrição
	ttRepresSource	Representante.
	ttEstabSource	Estabelecimento.
	ttTabPrecoSource	Tabela de preço.
	ttCondPagtoSource	Condição de pagamento.
Retorno	ttRepresSource (saida). ttEstabSource (saida). ttTabPrecoSource (saida). ttCondPagtoSource (saida).