Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prghur/fpp/fpapi058.p |
Objetivo
Retornar os históricos de transferência dos colaboradores.
Funcionamento
A API fpapi058 deve ser executada de forma persistente.
Sintaxe para executar a API em modo persistente:
run prghur/fpp/fpapi058.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-sit_afast_func | Contém os históricos de transferência | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
p_cdn_empresa | Inteiro | zz9 | Empresa | Sim | 2.10 |
p_cdn_estab | Inteiro | zz9 | Estabelecimento | Sim | 2.10 |
p_cdn_funcionario | Inteiro | zzzzzzz9 | Matrícula | Sim | 2.10 |
p_dat_inicio | Data | 99/99/9999 | Data início | Sim | 2.10 |
p_dat_fim | Data | 99/99/9999 | Data Fim | 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-sit_afast_func
Requisito | Inexistente. | |
Sintaxe | run procedure pi-sit_afast_func in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, input p_dat_inicio, input p_dat_fim, output table tt-sit_afast_func, output table tt-erro). | |
Descrição | O método retornará os históricos de transferência. | |
| Parâmetros | Descrição |
| p_cdn_empresa p_cdn_estab p_cdn_funcionario p_dat_inicio p_dat_fim tt-sit_afast_func tt-erro | Empresa Estabelecimento Matrícula Data início Data fim Temp-table com os históricos de transferência Erros do processo. |
Retorno | Temp-tables tt-sit_afast_func e tt-erro populadas. As mensagens possíveis para este método são: "Não existe histórico de afastamento para esse funcionário!" |
Método Negócio