Linha RM

Atalhos

Páginas filhas
  • DT - Integração RM X Quírons - API para retornar a lista dos subordinados diretos do líder

Versões comparadas

Versão antiga 11

changes.mady.by.user Yuri Buenaga Holtz

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Simone Cristina Dos Reis

Gravado em

Chave

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

01. DADOS GERAIS

DT - Integração RM x Feedz - Melhoria nas mensagens de Integr
Produto:

RM

Linha de Produto:

Linha RM

Segmento:

RH

Módulo:TOTVS Folha de Pagamento 
Função:Integração RM X Quírons : - API para retornar a lista do Lider direto dos empregados dos subordinados diretos do líder
País:Brasil
Requisito/Story/Issue (informe o requisito relacionado) :

DRHROTRM-10231


02. LIBERAÇÃO

Lembrando que, será a partir dos patches:

  • 12.1.23102402.195
  • 12.1.2402.12.1.2410 2406.122 e superiores

03. SITUAÇÃO/REQUISITO

Atualmente foi disponibilizado para o cliente uma query para que dentro do LMS o gestor consiga visualizar os dados do seu subordinado, mas implementarmos essa query seria inviável, devido a performance. Pois iria prejudicar os clientes que utilizam a API e não necessitam dessa informação.Disponibilizar uma API que retorne a lista dos subordinados diretos de cada líder, permitindo que o gestor visualize os dados de seus subordinados.

04. SOLUÇÃO

Implementada a Foi criada uma API employeesManagerDataContent que irá retornar uma lista contendo o líder direto dos empregados, semelhante a API employeeDataContent que retorna a lista dos retorna a lista dos subordinados diretos de cada líder, similar à API "employeeDataContent", que fornece a lista de empregados.


A API receberá os seguintes query params:

Query Param

Descrição

Obrigatório

Tipo

Valor padrão

Valor de exemplo

companyIdCódigo do grupo de empresas para filtroSimString
branchIdCódigo da filial do empregado para filtroSimString
pagePágina que está sendo requisitadaNãoInteger
pageSizeQuantidade de registros por páginaNãoInteger
employeeCodeCódigo da matrícula do empregado para filtroNãoString
employeeCostCenterCodeCódigo do centro de custo do(s) empregado(s) para filtroNãoString


A API retornará as seguintes propriedades:

Propriedade

Descrição

Tipo

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


A propriedade items contém Contém as seguintes propriedades:

Propriedade

Descrição

Tipo

Origem do valor

managerBranchFilial do líderStringPSECAO.CODFILIAL
managerCodeMatrícula do líderStringPSUBSTCHEFE.CHAPASUBST, PSUBSTSUP.CHAPASUBST, PCHEFEEXTERNO.CODEXTERNO, PSUPERVEXTERNO.CODEXTERNO
managerNameNome do líderStringPPESSOA.NOME
managerFullNameNome completo do líderStringPPESSOA.NOME
managerEmailE-mail do líderStringPPESSOA.EMAIL
managerDepartmentCodeCódigo do departamento do líderStringPSECAO.CODSECAO
managerDepartmentDescriptionDescrição do departamento do líderStringPSECAO.DESCRICAO
managerCostCenterCodeCódigo do centro de custo do líderStringPCCUSTO.CODIGO
managerCostCenterDescriptionDescrição do centro de custo do líderStringPFUNC.CODCCUSTO
managerExternalÉ externo?boolPCHEFEEXTERNO, PSUPERVEXTERNO
employeeBranchFilial do empregadoStringPFUNC.CODFILIAL
employeeCodeMatrícula do empregadoStringPFUNC.CHAPA
employeeNameNome do empregadoStringPPESSOA.NOME
employeeFullNameNome completo do empregadoStringPPESSOA.NOME

Exemplos de requisição e retorno:

Requisição

Retorno

Explicação

http://localhost:8060/rest/rh/v1/employeesManagerDataContent?companyId=T2&branchId=L MG 01 

 Expandir origem

Retorno dos empregados e respectivos líderes da empresa T2 e filial L MG 01 http://localhost:8060/rest/rh/v1/employeesManagerDataContent?companyId=T2&branchId=L MG 01 &pageSize=6

 Expandir origem

Retorno dos empregados e respectivos líderes da empresa T2 e filial L MG 01 , com paginação de 6 registros por páginahttp://localhost:8060/rest/rh/v1/employeesManagerDataContent?companyId=T2&branchId=L MG 01 &employeeCode=408081

 Recolher origem

{
    "hasNext": false,
    "total": 1,
    "items": [
        {
            "managerBranch": "L MG 01 ",
            "managerCode": "408080",
            "managerName": "COORDENADORA",
            "managerFullName": "COORDENADORA",
            "managerEmail": "coordenadora@totvs.com.br",
            "managerDepartmentCode": "999999907",
            "managerDepartmentDescription": "SQUAD",
            "managerCostCenterCode": "1.01.01             ",
            "managerCostCenterDescription": "FOLHA DE PAGAMENTO",
            "employeeBranch": "L MG 01 ",
            "employeeCode": "408081",
            "employeeName": "ANALISTA",
            "employeeFullName": "ANALISTA"
        }
    ]
}

Retorno do empregado e respectivo líder da empresa T2, filial L MG 01  e matrícula 408081http://localhost:8060/rest/rh/v1/employeesManagerDataContent?companyId=T2&branchId=L MG 01 &employeeCostCenterCode=1.01.01

 Expandir origem

Retorno dos empregados e respectivos líderes da empresa T2, filial L MG 01  e centro de custo 1.01.01


Situações de erros tratados:

Código do status

Mensagem

Solução

400O parâmetro companyId é obrigatório.Preencher o parâmetro companyId.
400O parâmetro branchId é obrigatório.Preencher o parâmetro branchId
.400Nenhum registro localizado.Revisar os parâmetros enviados
.


Situações de erros inesperados:

Código do status

Mensagem

500Ocorreu uma falha no retorno da informação.

...


05.

...

DEMAIS INFORMAÇÕES

Exemplo de configuração do REST.

05. ASSUNTOS RELACIONADOS

Não há.

...