Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

prghur/fpp/fpapi068.p

 

Objetivo

Incluir e alterar anotações na carteira de trabalho, além de retornar temp-table com as anotações. 

 

Funcionamento

A API/BO

Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se as informações necessárias.

A sintaxe para a chamada da API/BO é:

A api somente poderá ser executada em modo persistente.

 

A sintaxe para executar a API/BO em modo persistente é:

 

run prghur/fpp/fpapi068 persistent set h-handle.

 

run pi_anotacoes in h-handle (  output table tt_anot_geral_func,

                                 output table tt-erro).

 

Run pi_altera_anotacoes in h_handle ( input v_cdn_empresa,

                                        Input v_cdn_estab,

                                        Input v_cdn_funcionario,

                                         Input v_dat_anot_geral_func,

                                        Input v_des_anot_geral_func,

                                        Input v_tipo_alteracao).

 

 

A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.

 

Tabelas Temporárias

 

Temp table: tt-niv_hier_funcnal

Descrição do Campo

Campo

Formato

Empresa

Cdn_empresa

X(3)

Estabelecimento

Cdn_estab

X(5)

Matrícula

Cdn_funcionario

Zzzzzzz9

Data Anotação Geral

dat_anot_geral_func

99/99/99

Descrição da Anotação Geral

des_anot_geral_func

X(2000)

 

Temp table: tt-erro

Descrição do Campo

Campo

Formato

Código do Erro

Code

999

Descrição do Erro

Description

X(60)

 

Parâmetros utilizados pela API:

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

V_cdn_empresa

Char

X(03)

Empresa

sim

2.12

V_cdn_estab

Char

X(05)

Estabelecimento

sim

2.12

V_cdn_funcionario

Int

Zzzzzzz9

Matrícula

sim

2.12

V_dat_anot_geral_func

date

99/99/999

Data Anotação Geral

sim

2.12

V_des_anot_geral_func

char

X(2000)

Descrição Anotação Geral

sim

2.12

V_tipo_alteração

Int

9

Tipo de Anotação

sim

2.12

 

Métodos

Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

pi_anotacoes

pi_altera_anotacoes

 

Método Básico

Pi_anotações – retorna as anotações da CTPS dos funcionários.

pi_altera_anotacoes – inclui ou altera anotações da CTPS de um determinado funcionário.

 

Método Negócio

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