Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

 prghur/bsp/bsapi004.p

 

Objetivo

Retornar o código e a descrição das regras do formulário de benefícios de uma determinada empresa. 

 

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

 

run pi-retorna-regras-formul-benefic in h-handle (input v_cdn_empresa,

                                                  output table tt-formul-calc-benefic).

 

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-regra-benefic

Descrição do Campo

Campo

Formato

Código da Empresa

cdn_formul_calc_benefic

>>>9

Descrição da Regra do Benefício

des_formul_benefic

X(50)

 

Parâmetros utilizados pela API:

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

V_cdn_empresa

Char

X(3)

Empresa

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-regras-formul-benefic

 

Método Básico

pi-retorna-regras-formul-benefic – retorna uma temp-table com o código e a descrição das regras de benefício encontrado com base no código da empresa enviado como parâmetro de entrada.

 

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