Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prghur/fpp/fpapi042.p |
Objetivo
Retorna o período de ponto dos colaboradores.
Funcionamento
A API fpapi042 deve ser executada de forma persistente.
Sintaxe para executar a API em modo persistente:
run prghur/fpp/fpapi042.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-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 sit_calc_refer
Requisito | Inexistente. | |
Sintaxe | run procedure sit_calc_refer in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, output p_dat_inic_per, output p_dat_term_per, output p_num_mes_refer, output table tt-erro). | |
Descrição | O método retornará se é possível alterar batidas. | |
| Parâmetros | Descrição |
| p_cdn_empresa p_cdn_estab p_cdn_funcionario p_dat_inic_per p_dat_term_per p_num_mes_refer tt-erro | Empresa Estabelecimento Matrícula Data de início do período Data de término do período Mês de referência Erros do processo. |
Retorno | Temp-table tt-erro populada quando houver erro. As mensagens possíveis para este método são: "Período do Ponto Eletrônico (Empresa, Estabelecimento, Matrícula, Mês/Ano) não encontrado!" "Empresa (Empresa) inexistente!” |
procedure referenceMonth
Requisito | Inexistente. | |||
Sintaxe | run procedure referenceMonth in h-handle (input p_cdn_empresa, output p_referenceMonthYearInitial, output p_referenceMonthYearFinal, output table tt-erro). | |||
Descrição | O método retornará o mês de referência da empresa. | |||
| Parâmetros | Descrição | ||
| p_cdn_empresa p_referenceMonthYearInitial p_referenceMonthYearFinal tt-erro | Empresa Data de início do mês de referência Data de fim do mês de referência Erros do processo. | ||
Retorno | Temp-table tt-erro populada quando houver erro. As mensagens possíveis para este método são: "Parâmetros do RH não encontrados para esta empresa!" |
Método Negócio