Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

prghur/frp/frapi005.p

 

Objetivo

Api para retornar valor saldo FGTS da rescisão.

 

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/frapi005 persistent set h-handle.

 

run pi-retorna-fgts-recisao in h-handle (      input v_cdn_empresa,

                                               input v_cdn_estab,

                                               input v_cdn_funcionario,

                                               input v_dat_rescisao,

                                               output v_log_indic_fgts_mes,

                                               output v_val_sdo_fgts_rescis).

 

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_rescisao        

date

99/99/9999

Data da Rescisão

sim

2.12

V_log_indic_fgts_mes,            

log

Yes/No

FGTS do mês

sim

2.12

V_val_sdo_fgts_rescis             

dec

 

Valor do FGTS

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

 

Método Básico

pi-retorna-fgts-recisao: retorna valor do FGTS da rescisão.

 

Método Negócio

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