Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prghur/fpp/fpapi050.p |
Objetivo
Retornar o cadastro de unidades de negócio.
Funcionamento
A API fpapi050 deve ser executada de forma persistente.
Sintaxe para executar a API em modo persistente:
run prghur/fpp/fpapi050.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.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
Tabela Temporária | Descrição | Entrada/Saída |
tt-unid_negoc | Contém as unidades de negócio | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cod_unid_negoc | Inteiro | x(3) | Código da Unidade de Negócio | Sim | 2.10 |
des_unid_negoc | Caracter | x(40) | Descrição da Unidade de Negócio | Sim | 2.10 |
Tabela Temporária | Descrição | Entrada/Saída |
tt-erro | Contém código e descrição do erro | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
Code | Inteiro | Zz9 | Código do erro | Sim | 2.10 |
Description | Caracter | X(60) | Descrição do erro | Sim | 2.10 |
Métodos
Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
Método Básico
procedure pi-unid_negoc
Requisito | Inexistente. | |
Sintaxe | run procedure pi-unid_negoc in h-handle (output table tt-unid_negoc, output table tt-erro). | |
Descrição | O método retornará o cadastro dos planos de lotação. | |
| Parâmetros | Descrição |
| tt-unid_negoc tt-erro | Temp-table com as unidades de negócio Erros do processo. |
Retorno | Temp-tables tt-unid_negoc e tt-erro populadas. As mensagens possíveis para este método são: "Não existem Unidades de Negócio cadastradas!" |
Método Negócio