Linha Datasul

Árvore de páginas

Carregando...
Tempo aproximado para leitura: 1 minuto

 

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

 prghur/fpp/fpapi052.p

 

Objetivo

Retornar o cadastro de localidades.

 

Funcionamento

A API fpapi052 deve ser executada de forma persistente.

Sintaxe para executar a API em modo persistente:

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

Contém as localidades

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cod_pais

Caracter

x(3)

País

Sim

2.10

cdn_localidade

Inteiro

zzz9

Código Localidade

Sim

2.10

des_localidade

Caracter

x(40)

Descrição Localidade

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-localidade

Requisito

Inexistente.

Sintaxe

run procedure pi-localidade in h-handle

(output table tt-localidade,

 output table tt-erro).

Descrição

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

 

Parâmetros

Descrição

 

tt-localidade

tt-erro

Temp-table com as localidades

Erros do processo.

Retorno

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

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

"Não existem Localidades cadastradas!"

 

Método Negócio

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