Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prghur/fpp/fpapi014.p |
Objetivo
Realiza a exportação das informações de código e descrição da empresa do banco de dados.
Funcionamento
A API fpapi014 deve ser executada de forma persistente.
run prghur/fpp/fpapi014.p persistent set h-handle.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
Tabela Temporária | Descrição | Entrada/Saída |
tt-Company | Contém o código e descrição da empresa | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
companyCode | Inteiro | Zz9 | Código da empresa | Sim | 2.10 |
companyName | Caracter | X(40) | Nome da empresa | 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 piCompany
Requisito | Inexistente. | |
Sintaxe | run procedure piCompany in h-handle (output table tt-Company, output table tt-erro). | |
Descrição | O método retornará o cadastro de empresas. | |
| Parâmetros | Descrição |
| tt-Company tt-erro | Temp-table com o cadastro de empresas Erros do processo. |
Retorno | Temp-tables tt-erro e tt-Company populadas. As mensagens possíveis para este método são: "Não existem empresas cadastradas!"
|
Método Negócio