Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prghur/fpp/fpapi015.p |
Objetivo
Realiza a exportação das informações de código, descrição, C.G.C., C.E.I. e os formatos de C.G.C.e C.E.I. do estabelecimento do banco de dados.
Funcionamento
A API fpapi015 deve ser executada de forma persistente.
run prghur/fpp/fpapi015.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-Site | Contém o código, descrição, C.G.C., C.E.I. e os formatos de C.G.C.e C.E.I. do estabelecimento. | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
companyCode | Inteiro | Zz9 | Código da empresa | Sim | 2.10 |
siteCode | Inteiro | Zz9 | Código do estabelecimento | Sim | 2.10 |
siteName | Caracter | X(40) | Nome do estabelecimento | Não | 2.10 |
CGC | Caracter | X(20) | C.G.C. do estabelecimento | Não | 2.10 |
CEI | Caracter | X(20) | C.E.I. do estabelecimento | Não | 2.10 |
cgcFormat | Caracter | X(20) | Formato do C.G.C. do estabelecimento | Não | 2.10 |
ceiFormat | Caracter | X(20) | Formato do C.E.I. do estabelecimento | Não | 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étodo Básico
procedure piSite
Requisito | Inexistente. | |
Sintaxe | run procedure piSite in h-handle (output table tt-Site, output table tt-erro). | |
Descrição | O método retornará o cadastro de estabelecimentos. | |
| Parâmetros | Descrição |
| tt-Site tt-erro | Temp-table com o cadastro de estabelecimentos 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 estabelecimentos cadastrados!"
|
Método Negócio