Páginas filhas
  • DT - Integração Folha x Afferolab - Implementar filtro de Cargo, Departamento e Centro de Custo

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

1. DADOS GERAIS

Produto:

RM

Linha de Produto:

Linha RM

Segmento:

RH

Módulo:TOTVS Folha de Pagamento 
Função:Integração Folha x LMS+LXP by Afferolab
País:Brasil
Issue:DRHROTRM-14184

02. LIBERAÇÃO

  Lembrando que, será a partir dos patches:

...

03. SITUAÇÃO/REQUISITO

...

Disponibilizar filtros opcionais por departamento e cargo na API de integração entre a Folha de Pagamento e o LMS+LXP , para permitir o controle de quais funcionário devem ser integrados.

 Inicialmente os filtros deverão possibilitar combinações abaixo:

.

...

...


04. SOLUÇÃO 

Foi ajustada a API EmployeesManagerDataContent para retornar apenas os chefes cujo campo RECCREATEDON seja maior ou igual à data fornecida na requisição.   Isso garantirá que sejam utilizados filtros para controlar quais funcionarios seram integradosimplementada na APIEmployeeDataContentController a opção de filtrar por departamento e cargo do funcionário.

A API receberá os seguintes query params:

...

string

formato (aaaa-mm-dd)

...

string

formato (aaaa-mm-dd)

Query Param

DescriçãoObrigatório           Tipo               
departmentCodeDepartamento do funcionário (PFUNC.CODSECAO => PSECAO.CODDEPARTAMENTO)NãoInteger
employeePositionCodeCargo do funcionário (PFUNC.CODFUNCAO => PCARGO.CODIGO)NãoInteger


A API retornará as seguintes propriedades:

Propriedade  DescriçãoTipo
hasNextIndica se há registros na próxima páginaBoolean
totalIndica o total de registros retornadosInteger
itemsLista dos líderes direto dos empregadosArray

Contém as seguintes propriedades:

...


As propriedades do json podem ser encontradas aqui:
https://api.totvs.com.br/apidetails/EmployeeDataContent_v1_000.json

Situações de erros tratados:

Código do statusMensagemSolução
400O parâmetro product

Situações de erros tratados:

400O parâmetro companyId
é obrigatório.Preencher o parâmetro
companyId
product.
400O parâmetro
branchId
companyId é obrigatório.Preencher o parâmetro
branchId
companyId.


Situações de erros inesperados:

Código do statusMensagem
500Ocorreu uma falha no retorno da informação.

05. MÚLTIPLOS FILTROS

É possível realizar filtros múltiplos na API combinando várias condições com os operadores lógicos. Por exemplo:

{{baseURL}} /api/rh/v1/employeeDataContent?product=RM&companyId=1&$filter=( (roleCode eq '00017') and (sectionCode eq '02.01' or sectionCode eq '01.08') )

Esse filtro retorna os funcionários da função 00017 que estão alocados nas seções 02.01 ou 01.08. Todos os critérios devem ser combinados em um único $filter para evitar erros de sintaxe.

07.EXEMPLO POSTMAN



View file
nameIntegração Afferolab.postman_collection.json
height250


06. DEMAIS INFORMAÇÕES

Exemplo de configuração do REST.

...