Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prghur/bsp/bsapi006.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/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_depend_func,
input v_cdn_beneficio,
input v_cdn_regra_benefic,
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_depend_func | Int | Zz9 | Código Dependente | 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_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 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.