Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prghur/fpp/fpapi033.p |
Objetivo
Realiza a exportação dos sindicatos.
Funcionamento
A API fpapi033 deve ser executada de forma persistente.
run prghur/fpp/fpapi033.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-LaborUnion | Contém informações dos sindicatos de trabalho | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
codeLaborUnion | Inteiro | Zzzzzzz9 | Código do Sindicato | Sim | 2.10 |
descriptionLaborUnion | Caracter | X(40) | Nome da pessoa jurídica do sindicato | Sim | 2.10 |
collectiveAgreementMonthLaborUni | Inteiro | 99 | Mês da Reversão Sindical | Sim | 2.10 |
generateStabilityLaborUnion | Lógico | Yes/No | Indica se gera estabilidade | 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 piLaborUnion
Requisito | Inexistente. | |
Sintaxe | run procedure piLaborUnion in h-handle (output table tt-LaborUnion, output table tt-erro). | |
Descrição | O método retornará o cadastro de sindicatos. | |
| Parâmetros | Descrição |
| tt-LaborUnion tt-erro | Temp-table com o cadastro de sindicatos Erros do processo. |
Retorno | Temp-tables tt-erro e tt-LaborUnion populadas. As mensagens possíveis para este método são: "Não existem sindicatos cadastrados!" |
Método Negócio