Árvore de páginas

Carregando...

 

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

 prghur/fpp/fpapi021.p

 

Objetivo

Realiza a exportação das informações do calendário de feriados do banco de dados. 

 

Funcionamento

A API fpapi021 deve ser executada de forma persistente.

run prghur/fpp/fpapi021.p persistent set h-handle.

 

Tabelas Temporárias

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

 

Tabela Temporária

Descrição

Entrada/Saída

tt-Holiday

Contém informações do calendário de feriados

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

Country

Caracter

X(03)

Código do país

Sim

2.10

holidayCalendar

Caracter

X(08)

Código do calendário de feriados para o turno

Sim

2.10

Description

Caracter

X(40)

Descrição do feriado da localidade

Sim

2.10

holidayDay

Data

dd/nn/aaaa

Data do feriado

Sim

2.10

holidayTyoe

Inteiro

9

Tipo do feriado (0 para nacional e 1 para local)

Sim

2.10

localCode

Inteiro

Zzz9

Código da localidade

Sim

2.10

localDescription

Caracter

X(40)

Descrição da 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 piHoliday

Requisito

Inexistente.

Sintaxe

run procedure piHoliday in h-handle

(output table tt-Holiday,

 output table tt-erro).

Descrição

O método retornará o cadastro de feriados.

 

Parâmetros

Descrição

 

tt-Holiday

tt-erro

Temp-table com o cadastro de feriados

Erros do processo.

Retorno

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

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

"Não existem feriados cadastrados!"


Método   Negócio

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