Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prghur/frp/frapi006.p |
Objetivo
Api para listar e atualizar status de aviso e abono de férias.
Funcionamento
A API/BO
Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se as informações necessárias.
A sintaxe para a chamada da API/BO é:
A api somente poderá ser executada em modo persistente.
A sintaxe para executar a API/BO em modo persistente é:
run prghur/frp/frapi006 persistent set h-handle.
Run pi-retorna-req-abono-férias in h-handle (input v_cdn_empresa,
input v_cdn_estab,
input v_cdn_funcionario).
Run pi-atualiza-status-req-abono in h-handle (input v_cdn_empresa,
input v_cdn_estab,
input v_cdn_funcionario,
input v_dat_inic_ferias,
input v_dat_inic_period_aqst_ferias).
run pi-retorna-avisos-ferias in h-handle ( input v_cdn_empresa,
input v_cdn_estab,
input v_cdn_funcionario,
input v_dat_inic_concess,
input v_dat_term_concess).
Run pi-status-aviso-férias in h-handle (input v_cdn_empresa,
input v_cdn_estab,
input v_cdn_funcionario,
input v_dat_inic_ferias,
input v_dat_inic_period_aqst_ferias).
A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.
Tabelas Temporárias
Não se aplica
Parâmetros utilizados pela API :
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
V_cdn_empresa | Char | X(3) | Empresa | sim | 2.12 |
v_cdn_estab, | Char | X(5) | Empresa | sim | 2.12 |
v_cdn_funcionario, | Int | Zzzzzzz9 | Matrícula | sim | 2.12 |
V_dat_inic_ferias | date | 99/99/9999 | Data Início das Férias | sim | 2.12 |
V_dat_inic_period_aqst_ferias | date | 99/99/9999 | Data Início Período Aquis Férias | sim | 2.12 |
V_dat_inic_conces | date | 99/99/9999 | Data Início Concessão | sim | 2.12 |
V_dat_term_conces | date | 99/99/9999 | Data Término Concessão | sim | 2.12 |
Métodos
Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
pi-retorna-req-abono-férias
pi-atualiza-status-req-abono
pi-retorna-avisos-férias
pi-status-aviso-férias
Método Básico
pi-retorna-req-abono-férias: lista todas as requisições de abono de férias do funcionário
pi-atualiza-status-req-abono: atualizar o status de impressão da requisições de abono do funcionário
pi-retorna-avisos-férias: lista todos os avisos de férias do funcionário
pi-status-aviso-férias: atualizar o status de impressão do aviso de férias do funcionário
Método Negócio
Não há método de negócio disponível nesta api.