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/fpapi057.p

 

Objetivo

Retornar os países.

 

Funcionamento

A API fpapi057 deve ser executada de forma persistente.

Sintaxe para executar a API em modo persistente:

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

rh_pais

Contém os países

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cod_pais

Caracter

x(3)

Código do Pais

Sim

2.10

nom_pais

Caracter

x(32)

Nome País

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 pi-pais

Requisito

Inexistente.

Sintaxe

run procedure pi-pais in h-handle

(output table tt-pais,

 output table tt-erro).

Descrição

O método retornará os países.

 

Parâmetros

Descrição

 

tt-pais

tt-erro

Temp-table com os países

Erros do processo.

Retorno

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

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

"Não existem Países cadastrados!"


Método Negócio

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