Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prghur/fpp/fpapi045.p |
Objetivo
Retornar os motivos de estabilidade cadastrados.
Funcionamento
A API fpapi045 deve ser executada de forma persistente.
Sintaxe para executar a API em modo persistente:
run prghur/fpp/fpapi045.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-EmployeeStability | Contém as registros de estabilidade dos colaboradores | 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 |
stabilityCode | Inteiro | >9 | Código Motivo Estabilidade | Sim | 2.10 |
stabilityDescription | Caracter | x(30) | Descrição Motivo Estabilidade | Sim | 2.10 |
stabilityTypeEnum | Inteiro | >9 | Identificação Origem | Sim | 2.10 |
stabilityInitialDate | Data | 99/99/9999 | Data de início da estabilidade | Sim | 2.10 |
stabilityEndDate | Data | 99/99/9999 | Data de fim da estabilidade | 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 piFindEmployeeStabilities
Requisito | Inexistente. | |
Sintaxe | run procedure piFindEmployeeStabilities in h-handle (output table tt-EmployeeStability, output table tt-erro). | |
Descrição | O método retornará os motivos de estabilidade. | |
| Parâmetros | Descrição |
| tt-EmployeeStability tt-erro | Temp-table com os registros de estabilidade Erros do processo. |
Retorno | Temp-tables tt-EmployeeStability e tt-erro populadas. As mensagens possíveis para este método são: "Não existem funcionários com estabilidade cadastrada!" |
Método Negócio