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