Árvore de páginas

 

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

 prghur/fpp/fpapi059.p

 

Objetivo

Retorna as matrículas em cursos assíncronos (EPM) e também fichas de inventários de cursos assíncronos.

 

Funcionamento

A sintaxe para executar a API em modo persistente é:

 

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

 

A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso ao “método” interno 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-hist_graduacao

Históricos de Matrículas e Fichas de Inventário (avaliações).

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cdn_empresa

character

X(3)

Empresa

SIM

 

cdn_estab

character

X(5)

Estabelecimento

SIM

 

cdn_funcionario

integer

>>>>>>9

Funcionário

SIM

 

cdn_curso_trein

integer

>>>>>9

Curso

SIM

 

des_curso_trein

character

X(40)

Descrição

SIM

 

idi_sit_trein

integer

9

Situação Treinamento

SIM

 

dat_inic_curso_trein

date

MM/DD/AAAA

Data Início

NÃO

 

dat_fim_curso_trein

date

MM/DD/AAAA

Data Fim

NÃO

 

cdn_tip_curso_trein

integer

>>>>>9

Tipo Curso

NÃO

 

des_tip_curso_trein

character

X(40)

Descrição Tipo Curso

NÃO

 

cdn_instit_trein

integer

>>>>>9

Instituição Treinamento

NÃO

 

des_instit_trein

character

X(40)

Descrição Instituição

NÃO

 

dat_matr_curso_trein

date

MM/DD/AAAA

Data Matrícula

NÃO

 

dat_valid_curso_trein

date

MM/DD/AAAA

Data Validade

NÃO

 

cdn_motiv_desabtcao_treindo

integer

>>>>>9

Motivo Desabilitação

NÃO

 

des_motiv_desabtcao_treindo

character

X(20)

Descrição Motivo

NÃO

 

idi_tip_trein

integer

9

Tipo Treinamento

NÃO

 

des_tip_trein

character

X(12)

Descrição Tipo Treinamento

NÃO

 

val_not_media

decimal

999,999

Nota Média

NÃO

 

val_pre_teste

decimal

999,999

Pré-Teste

NÃO

 

val_pos_teste

decimal

999,999

Pós-Teste

NÃO

 

nom_vers_trein

character

X(30)

Versão Treinamento

NÃO

 

des_url

character

X(1000)

Servidor EPM

NÃO

 

Tabela Temporária

Descrição

Entrada/Saída

tt-error

Contém erros de parâmetros ou base que a API pode identificar

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

code

integer

999

Código do Erro

SIM

 

description

character

X(60)

Descrição do Erro

SIM

 

 

Métodos

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


Método Básico

pi-hist_graduacao

Requisito

Funcionário e faixa de data para leitura de histórico.

Sintaxe

 

run pi-hist_graduacao in h-handle (input v_cdn_empresa,

                                   input v_cdn_estab,

                                   input v_cdn_funcionario,

                                   input v_dat_inicio,

                                   input v_dat_fim,

                                   output table tt-hist_graduacao,

                                   output table tt-erro).

Descrição

Retorna todos as fichas de inventários ou matrícula em cursos assíncronos (EPM).

 

Parâmetros

Descrição

 

v_cdn_empresa

Empresa do Funcionário.

 

v_cdn_estab

Estabelecimento do Funcionário.

 

v_cdn_funcionario

Matrícula do Funcionário

 

v_dat_inicio

Data inicial da faixa de seleção.

 

v_dat_fim

Data final da faixa de seleção.

Retorno

O retorno com o histórico é armazenado na tabela temporária tt-hist_graduação. Problemas identificados pela API são retornados através da tt-erro.