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