FPAPI056 - Retornar as unidades de federação.

Documento de API

Objetivo

Retornar as unidades de federação.

A API fpapi056 deve ser executada de forma persistente.

Sintaxe para executar a API em modo persistente:

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

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

Tabela Temporária	Descrição	Entrada/Saída
tt-unid_federac	Contém as unidades de federação	Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
cod_unid_federac	Caracter	x(04)	Código da unidade de federação	Sim	2.10
des_unid_federac	Caracter	x(25)	Descrição da unidade de federação	Sim	2.10
cod_pais	Caracter	x(3)	Código do Pais	Sim	2.10

Tabela Temporária	Descrição	Entrada/Saída
tt-erro	Contém código e descrição do erro	Saída

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

Requisito	Inexistente.
Sintaxe	run procedure pi-unid_federac in h-handle (output table tt-unid_federac, output table tt-erro).
Descrição	O método retornará as unidades de federação.
	Parâmetros	Descrição
	tt-unid_federac tt-erro	Temp-table com as unidades de federação Erros do processo.
Retorno	Temp-tables tt-unid_federac e tt-erro populadas. As mensagens possíveis para este método são: "Não existem Unidades de Federação cadastradas!"

Método Negócio