Árvore de páginas

Carregando...

 

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

 prghur/fpp/fpapi019.p

 

Objetivo

Realiza a exportação das informações dos tipos de compensação da base de dados.

 

Funcionamento

A API fpapi019 deve ser executada de forma persistente.

Sintaxe para executar a API em modo persistente:

run prghur/fpp/fpapi019.p persistent set h-handle.

 

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

 

Tabelas Temporárias

Nos atributos das tabelas temporárias de entrada e saída:

 

Tabela Temporária

Descrição

Entrada/Saída

tt-TimeAccountType

Contém informações dos tipos de compensação

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

timeAccountType

Inteiro

Z9

Código do tipo de compensação

Sim

2.10

Description

Caracter

X(30)

Descrição do tipo de compensação

Sim

2.10

timeAccountId

Inteiro

9

Tipo das horas compensadas

Sim

2.10

Tabela Temporária

Descrição

Entrada/Saída

tt-erro

Contém código e descrição do erro

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

Code

Inteiro

Zz9

Código do erro

Sim

2.10

Description

Caracter

X(60)

Descrição do erro

Sim

2.10

 

Métodos

Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

 

Método Básico

procedure piTimeAccountType

Requisito

Inexistente.

Sintaxe

run procedure piTimeAccountType in h-handle

(output table tt-TimeAccountType,

 output table tt-erro).

Descrição

O método retornará o cadastro de tipos de banco de horas.

 

Parâmetros

Descrição

 

tt-TimeAccountType

tt-erro

Temp-table com o cadastro de tipos de banco de horas

Erros do processo.

Retorno

Temp-tables tt-erro e tt-TimeAccountType populadas.

As mensagens possíveis para este método são:

"Não existem tipos de banco de horas cadastrados!"


Método   Negócio

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