Linha Datasul

Árvore de páginas

Tempo aproximado para leitura: 1 minuto

 

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

 prghur/fpp/fpapi036.p

 

Objetivo

Realiza a exportação dos motivos ou observações cadastrados na base de dados.

 

Funcionamento

A API fpapi036 deve ser executada de forma persistente.

run prghur/fpp/fpapi036.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-Motive

Contém informações dos motivos ou observações

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

companyCode

Inteiro

Z9

Código da empresa

Sim

2.10

codeMotive

Inteiro

Zzz9

Código do motivo

Sim

2.10

descriptionMotive

Caracter

X(40)

Descrição do motivo

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 piMotive

Requisito

Inexistente.

Sintaxe

run procedure piMotive in h-handle

(output table tt-Motive,

 output table tt-erro).

Descrição

O método retornará o cadastro de motivos.

 

Parâmetros

Descrição

 

tt-Motive

tt-erro

Temp-table com o cadastro de situações de motivos

Erros do processo.

Retorno

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

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

"Não existem motivos cadastrados!"


Método   Negócio

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