Árvore de páginas

 

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

prghur/fpp/fpapi027.p

 

Objetivo

Realiza a exportação das informações de unidades de lotação do banco de dados.

 

Funcionamento

A API fpapi027 deve ser executada de forma persistente.

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

 

Tabelas Temporárias

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

 

Tabela Temporária

Descrição

Entrada/Saída

tt-AllocationUnit

Contém informações da unidade de lotação

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

codeAllocationUnit

Caracter

X(11)

Código da unidade de lotação

Sim

2.10

descriptionAllocationUnit

Caracter

X(40)

Descrição da unidade de lotação

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 piAllocationUnit

Requisito

Inexistente.

Sintaxe

run procedure piAllocationUnit in h-handle

(output table tt-AllocationUnit,

 output table tt-erro).

Descrição

O método retornará o cadastro de unidades de lotação.

 

Parâmetros

Descrição

 

tt-AllocationUnit

tt-erro

Temp-table com o cadastro de unidades de lotação

Erros do processo.

Retorno

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

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

"Não existem unidades de lotação cadastradas!"


Método   Negócio

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