Árvore de páginas

Documento de API

 

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

 prghur/fpp/fpapi020.p

 

Objetivo

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

 

Funcionamento

A API fpapi020 deve ser executada de forma persistente.

Sintaxe para executar a API em modo persistente:

run prghur/fpp/fpapi020.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-WorkTurn

Contém informações dos tipos de turnos de trabalho

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

code

Inteiro

9999

Código do turno de trabalho

Sim

2.10

description

Caracter

X(30)

Descrição do turno de trabalho

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 piWorkTurn

Requisito

Inexistente.

Sintaxe

run procedure piWorkTurn in h-handle

(output table tt-WorkTurn,

 output table tt-erro).

Descrição

O método retornará o cadastro de tipos de turnos.

 

Parâmetros

Descrição

 

tt-WorkTurn

tt-erro

Temp-table com o cadastro de tipos de turnos

Erros do processo.

Retorno

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

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

"Não existem turnos de trabalho cadastrados!"


Método   Negócio

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