Árvore de páginas

 

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

 prghur/bsp/bsapi005.p

 

Objetivo

Retornar o código e a descrição de valores unitários por 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-valores-unitarios in h-handle (input v_cdn_empresa,

                                              output table tt-val-unit-form-fp).

 

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 Valor Unitário

cdn_val_unit_fp

>>9

Descrição Valor Unitário

des_val_unit_fp

X(30)

 

Parâmetros utilizados pela API:

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

V_cdn_empresa

Char

X(03)

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:

-retorna-valores-unitarios

 

Método Básico

-retorna-valores-unitarios – retorna uma temp-table com o código e a descrição dos valores unitários encontrados com base na empresa enviado como parâmetro de entrada.


Método   Negócio

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