| 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 |
Lembrando que, será a partir dos patches:
Disponibilizar filtros 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.
04. SOLUÇÃO
Foi implementada na API EmployeeDataContentController a opção de filtrar por departamento e cargo do funcionário.
A API receberá os seguintes query params:
Query Param | Descrição | Obrigatório | Tipo |
|---|---|---|---|
| departmentCode | Departamento do funcionário (PFUNC.CODSECAO => PSECAO.CODDEPARTAMENTO) | Não | Integer |
| employeePositionCode | Cargo do funcionário (PFUNC.CODFUNCAO => PCARGO.CODIGO) | Não | Integer |
A API retornará as seguintes propriedades:
| Propriedade | Descrição | Tipo |
|---|---|---|
| hasNext | Indica se há registros na próxima página | Boolean |
| total | Indica o total de registros retornados | Integer |
| items | Lista dos líderes direto dos empregados | Array |
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 status | Mensagem | Solução |
|---|---|---|
| 400 | O parâmetro product é obrigatório. | Preencher o parâmetro product. |
| 400 | O parâmetro companyId é obrigatório. | Preencher o parâmetro companyId. |
Situações de erros inesperados:
| Código do status | Mensagem |
|---|---|
| 500 | Ocorreu uma falha no retorno da informação. |
É 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.
Exemplo de configuração do REST.