Árvore de páginas

Carregando...

 

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

 prghur/fpp/fpapi066.p

 

Objetivo

Retornar os exames periódicos dos colaboradores.

 

Funcionamento

A API fpapi066 deve ser executada de forma persistente.

Sintaxe para executar a API em modo persistente:

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

Contém os exames periódicos

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

companyCode

Inteiro

Zz9

Código da empresa

Sim

2.10

siteCode

Inteiro

Zz9

Código do estabelecimento

Sim

2.10

Registry

Inteiro

Zzzzzzz9

Código de matrícula do funcionário

Sim

2.10

DateProgramming

Data

99/99/9999

Data da programação

Sim

2.10

DateAccomplishment

Data

99/99/9999

Data da realização

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

Requisito

Inexistente.

Sintaxe

run procedure pi-LatePeriodicExamination in h-handle

(input p_cdn_empresa,

 input p_cdn_estab,

 input p_cdn_funcionario,

 input p_dat_inicio,

 input p_dat_fim,

 output table tt-PeriodicExamination,

 output table tt-erro).

Descrição

O método retornará os exames periódicos atrasados.

 

Parâmetros

Descrição

 

p_cdn_empresa

p_cdn_estab

p_cdn_funcionario

p_dat_inicio

p_dat_fim

tt-PeriodicExamination

tt-erro

Empresa

Estabelecimento

Matrícula

Data de início

Data de fim

Temp-table com os exames periódicos

Erros do processo.

Retorno

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

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

"Não existem funcionários com periódico atrasado!"

procedure pi-ProgrammingPeriodicExamination

Requisito

Inexistente.

Sintaxe

run procedure pi-ProgrammingPeriodicExamination in h-handle

(input p_cdn_empresa,

 input p_cdn_estab,

 input p_cdn_funcionario,

 input p_dat_inicio,

 input p_dat_fim,

 output table tt-PeriodicExamination,

 output table tt-erro).

Descrição

O método retornará os exames periódicos programados.

 

Parâmetros

Descrição

 

p_cdn_empresa

p_cdn_estab

p_cdn_funcionario

p_dat_inicio

p_dat_fim

tt-PeriodicExamination

tt-erro

Empresa

Estabelecimento

Matrícula

Data de início

Data de fim

Temp-table com os exames periódicos

Erros do processo.

Retorno

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

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

"Não existem funcionários com periódico programado!"

 

Método Negócio

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