Árvore de páginas

 

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

 prghur/fpp/fpapi061.p

 

Objetivo

Retornar os históricos salariais dos colaboradores.

 

Funcionamento

A API fpapi061 deve ser executada de forma persistente.

Sintaxe para executar a API em modo persistente:

run prghur/fpp/fpapi061.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-hist_salario

Contém os históricos salariais dos colaboradores

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cdn_empresa

Inteiro

zz9

Empresa

Sim

2.10

cdn_estab

Inteiro

zz9

Estabelecimento

Sim

2.10

cdn_funcionario

Inteiro

zzzzzzz9

Matrícula

Sim

2.10

dat_liber_sal

Data

99/99/9999

Data da liberação salarial

Sim

2.10

num_seq_histor_sal

Inteiro

9

Sequência Histórico

Sim

2.10

cdn_motiv_liber_sal

Inteiro

>>9

Motivo da liberação

Sim

2.10

cdn_cargo_funcao

Inteiro

>>,>>9

Cargo ou Função

Sim

2.10

idi_tip_cargo_funcao

Inteiro

9

Indica se é um cargo ou uma função

Sim

2.10

cdn_niv_cargo

Inteiro

>>9

Nível

Não

2.10

val_salario_hora

Decimal

zzz,zz9.9999

Salário Hora

Sim

2.10

val_salario_mensal

Decimal

zz,zzz,zz9.9999

Salário Mensal

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-hist_salario

Requisito

Inexistente.

Sintaxe

run procedure pi-hist_salario 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-hist_salario,

 output table tt-erro).

Descrição

O método retornará os históricos de períodos aquisitivos e férias dos colaboradores.

 

Parâmetros

Descrição

 

p_cdn_empresa

p_cdn_estab

p_cdn_funcionario

p_dat_inicio

p_dat_fim

tt-hist_salario

tt-erro

Empresa

Estabelecimento

Matrícula

Data início

Data fim

Temp-table com os históricos salariais

Erros do processo.

Retorno

Temp-tables tt-hist_salario e tt-erro populadas.

As mensagens possíveis para este método são:

"Não foi encontrado histórico de salário para o funcionário informado!"


Método Negócio

Não há método de negócio disponível nesta api.