Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

 prghur/bsp/bsapi007.p 

 

Objetivo

Incluir benefício vale transporte. 

 

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

 

run pi-beneficio in h-handle (  input v_cdn_empresa,

                                 input v_cdn_estab,

                                 input v_cdn_funcionario,

                                 input v_cdn_beneficio,

      input v_cdn_regra_benefic,

       input v_cdn_lin_vale_transp

       input v_idi_tip_req_lin_transp

       input v_qti_padr_period_vale_func_lin

       input v_qti_padr_dia_vale_func_lin  

       input v_qti_sobras

       input v_qti_diaria_passes_seg

       input v_qti_diaria_passes_ter

       input v_qti_diaria_passes_qua

       input v_qti_diaria_passes_qui

       input v_qti_diaria_passes_sex

       input v_qti_diaria_passes_sab

       input v_qti_diaria_passes_dom

       input v_val_dist_percur

       input v_num_tempo_desloc

       input v_idi_tip_gerac,

      input v_idi_tip_data,

      output table tt-erro).

 

A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.

 

Tabelas Temporárias

 

Temp table: tt-erro

Descrição do Campo

Campo

Formato

Código do Erro

Code

999

Descrição do Erro

Description

X(60)

 

Parâmetros utilizados pela API:

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

V_cdn_empresa

Char

X(03)

Empresa

sim

2.12

V_cdn_estab

Char

X(05)

Estabelecimento

sim

2.12

V_cdn_funcionario

Int

Zzzzzzz9

Matrícula

sim

2.12

V_cdn_beneficio

Int

>>9

Código Benefício

sim

2.12

V_cdn_regra_benefic

Int

ZZ9

Regra Benefício

sim

2.12

v_cdn_lin_vale_transp

Int

>>>>9

Linha

sim

2.12

v_idi_tip_req_lin_transp

Int

>9

Requisição

sim

2.12

v_qti_padr_period_vale_func_lin

Int

>>9

Qtde Padrão

sim

2.12

v_qti_padr_dia_vale_func_lin

Int

>>9

Padrão Dia

Sim

2.12

v_qti_sobras

int

>>9

Qtde Sobras

Sim

2.12

v_qti_diaria_passes_seg

int

>>9

Qtde Passes Segunda

Sim

2.12

v_qti_diaria_passes_ter

int

>>9

Qtde Passes Terça

Sim

2.12

v_qti_diaria_passes_qua

int

>>9

Qtde Passes Quarta

Sim

2.12

v_qti_diaria_passes_qui

int

>>9

Qtde Passes Quinta

Sim

2.12

v_qti_diaria_passes_sex

int

>>9

Qtde Passes Sexta

Sim

2.12

V_idi_tip_regrac

Int

9

Tipo de Regra

sim

2.12

V_idi_tip_data

Int

9

Tipo de Data

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

 

Método Básico

Pi-beneficio – permite uncluir benefício vale trabsporte através dos parâmetros de entrada. Retorna temp-table de erro.

 

Método   Negócio

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

#trackbackRdf ($trackbackUtils.getContentIdentifier($page) $page.title $trackbackUtils.getPingUrl($page))