Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prghur/dsp/dsapi001.p |
Objetivo
Verificar as avaliações emitidas que um funcionário possua e disponibiliza-las para outras aplicações (integrações, portal ByYou HCM, etc. ).
A Api também recebe o resultado da avaliação realizada e integra com o produto HCM.
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 é:
run prghur/dsp/dsapi001.p (input v_cdn_empresa ,
input v_cdn_estab ,
input v_cdn_funcionario ,
input v_cdn_avpes_padr ,
input v_cdn_estab_avaliado ,
input v_cdn_func_avaliado ,
input v_dat_emis_ini ,
input v_dat_emis_fim ,
input v_log_pendentes ,
input v_log_respondidas ,
input v_log_atrasadas ,
OUTPUT v_des_url_servid_ams ,
output table for tt-avaliac ,
output table for tt-erro ).
A sintaxe para executar a API/BO em modo persistente é:
run prghur/dsp/dsapi001.p persistent set h-handle ( input v_cdn_empresa ,
input v_cdn_estab ,
input v_cdn_funcionario ,
input v_cdn_avpes_padr ,
input v_cdn_estab_avaliado ,
input v_cdn_func_avaliado ,
input v_dat_emis_ini ,
input v_dat_emis_fim ,
input v_log_pendentes ,
input v_log_respondidas ,
input v_log_atrasadas ,
output v_des_url_servid_ams ,
output table for tt-avaliac ,
output table for tt-erro ).
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-erro
Descrição do Campo | Campo | Formato |
Código do Erro | Code | 999 |
Descrição do Erro | Description | X(60) |
Temp-table: tt-avaliac
Descrição do Campo | Campo | Formato |
Número da Avaliação | Num_avpes_emitid |
|
Código da Avaliação | Cdn_avpes_padr |
|
Descrição da Avaliação | Des_avpes_padr |
|
Código Externo da Avaliação | Cdn_avpes_ext |
|
Prazo da Avaliação | Dat_refer_respos_avpes |
|
Tipo de Avaliação | idi_tip_avpes |
|
Empresa do Avaliador | Cdn_empres_avaldor |
|
Estabelecimento do Avaliador | Cdn_estab_avaldor |
|
Matrícula do Avaliador | Cdn_func_avaldor |
|
Tipo de Avaliador | Cdn_tip_avaldor_avpes |
|
Empresa do Avaliado | Cdn_empres_avaldo |
|
Estabelecimento do Avaliado | Cdn_estab_avaldo |
|
Matrícula do Avaliado | Cdn_func_avaldo |
|
Cargo do Avaliado | Cdn_cargo_basic |
|
Nível do Cargo do Avaliado | Cdn_niv_cargo |
|
Plano de Lotação do Avaliado | Cdn_plano_lotac |
|
Unidade de Lotação do Avaliado | Cod_unid_lotac |
|
Descrição da Unidade de Lotação do Avaliado | Des_unid_lotac |
|
Código do Curso | Cdn_curso_trein |
|
Descrição do curso | Des_curso_trein |
|
Código da Turma | Cdn_turma_trein |
|
Código da Bolsa de Estudo | Cdn_bolsa_estudo |
|
Descrição a Bolsa de Estudo | des_bolsa_estudo |
|
Retorno Avaliação | Idi_tip_retorno |
|
Valor Pontuação | Idi_tip_retorno |
|
Divulga Resultado | log_divulga_restdo_avpes |
|
Descrição Resultado | Des_result |
|
Descrição do Parecer | Des_parecer |
|
Parâmetros utilizados pela API:
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
V_cdn_empresa | Integer | 999 | Empresa | sim | 2.09 |
v_cdn_estab | Char | X(05) | Estabelecimento | Não | 2.11 |
v_cdn_funcionario | Integer | 99999999 | Matricula Funcionário | Não | 2.09 |
v_cdn_avpes_padr | Integer | >>>>>9 | Avaliação |
| 2.09 |
v_cdn_estab_avaliado | Char | X(05) | Estabelecimento Avaliado |
| 2.09 |
v_cdn_func_avaliado | int | 99999999 | Matrícula Funcionário avaliado |
| 2.09 |
v_dat_emis_ini | date | 99/99/9999 | Data inicial faixa data emissão |
| 2.09 |
v_dat_emis_fim | date | 99/99/9999 | Data fim faixa data emissão |
| 2.09 |
v_log_pendentes | logical | Sim/não | Avaliações Pendentes |
| 2.09 |
v_log_respondidas | logical | Sim/não | Avaliações Respondidas |
| 2.09 |
v_log_atrasadas | logical | Sim/não | Avaliações Atrasadas |
| 2.09 |
v_des_url_servid_ams | Char | char | URL do servidor AMS |
| 2.11 |
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
Não há método básico disponível nesta api.
Método Negócio
Não há método de negócio disponível nesta api.