Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prghur/fpp/fpapi049.p |
Objetivo
Retornar o cadastro de planos de lotação.
Funcionamento
A API fpapi049 deve ser executada de forma persistente.
Sintaxe para executar a API em modo persistente:
run prghur/fpp/fpapi049.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-plano_lotac | Contém os planos de lotação | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cdn_plano_lotac | Inteiro | >>9 | Código do Plano de Lotação | Sim | 2.10 |
des_plano_lotac | Caracter | x(40) | Descrição do Plano de Lotação | 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-plano_lotac
Requisito | Inexistente. | |
Sintaxe | run procedure pi-plano_lotac in h-handle (output table tt-plano_lotac, output table tt-erro). | |
Descrição | O método retornará o cadastro dos planos de lotação. | |
| Parâmetros | Descrição |
| tt-plano_lotac tt-erro | Temp-table com os planos de lotação Erros do processo. |
Retorno | Temp-tables tt-plano_lotac e tt-erro populadas. As mensagens possíveis para este método são: "Não existem Planos de Lotação cadastrados!" |
Método Negócio