Árvore de páginas

Carregando...

 

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

 prghur/fpp/fpapi016.p

 

Objetivo

Realiza a exportação das informações de funcionário e seus dependentes.

 

Funcionamento

A API fpapi016 deve ser executada de forma persistente.

run prghur/fpp/fpapi016.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-Employee

Contém informações dos funcionários

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

employeeName

Caracter

X(40)

Nome do funcionário

Sim

2.10

employeeImage

Caracter

X(30)

Endereço do diretório, onde se encontra hospedada uma imagem do funcionário

Não

2.10

professionalRegistrationNumber

Caracter

X(10)

Código da carteira de trabalho do funcionário

Não

2.10

professionalRegistrationSerie

Caracter

x(08)

Série da carteira de trabalho do funcionário

Não

2.10

employeeBankAccount

Integer

Zz9

Código do banco para depósito, do funcionário

Não

2.10

employeeBanckAccountAgency

Integer

zzz9

Código da agência bancária para depósito, do funcionário

Não

2.10

employeeAccountNumber

Integer

999999999

Conta bancária do funcionário

Não

2.10

employeeAccountDigit

Caracter

x(2)

Dígito da conta bancária do funcionário

Não

2.10

Tabela Temporária

Descrição

Entrada/Saída

tt-dependents

Contém informações sobre os dependentes dos funcionários

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

dependentCode

Inteiro

Zz9

Código do dependente

Sim

2.10

dependentName

Caracter

X(40)

Nome do dependente

Sim

2.10

dependentRelationType

Inteiro

99

Grau de dependência do dependente para com o funcionário

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:

procedure piEmployee

Requisito

Inexistente.

Sintaxe

run procedure piEmployee in h-handle

(output table tt-Employee,

 output table tt-dependents,

 output table tt-erro).

Descrição

O método retornará o cadastro de funcionários e dependentes.

 

Parâmetros

Descrição

 

tt-Employee

tt-dependents

tt-erro

Temp-table com o cadastro de funcionários

Temp table com o cadastro de dependentes

Erros do processo.

Retorno

Temp-tables tt-erro, tt-Employee e  tt-dependents populadas.

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

"Não existe usuário cadastrado para este colaborador!"

"Não existem funcionários cadastrados!"


Método   Negócio

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