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 8

changes.mady.by.user Silvana Maria Pessoa de Melo

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çãoDisponibilizar 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 filtro
NãoStringvisionCodeCódigo da visão contendo a estrutura hierárquica quando utilizado o parâmetro MV_ORGCFG com 1 ou 2
Nã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íderString
RA_FILIAL
PSECAO.CODFILIAL
managerCodeMatrícula do líderString
RA_MAT
PSUBSTCHEFE.CHAPASUBST, PSUBSTSUP.CHAPASUBST, PCHEFEEXTERNO.CODEXTERNO, PSUPERVEXTERNO.CODEXTERNO
managerNameNome do líderString
RA_
PPESSOA.NOME
managerFullNameNome completo do líderString
RA_NOMECMP
PPESSOA.NOME
managerEmailE-mail do líderString
RA_
PPESSOA.EMAIL
managerDepartmentCodeCódigo do departamento do líderString
RA_DEPTO
PSECAO.CODSECAO
managerDepartmentDescriptionDescrição do departamento do líderString
QB_DESCRIC
PSECAO.DESCRICAO
managerCostCenterCodeCódigo do centro de custo do líderString
RA_CC
PCCUSTO.CODIGO
managerCostCenterDescriptionDescrição do centro de custo do líderString
CTT_DESC01
PFUNC.CODCCUSTO
managerExternalÉ externo?boolPCHEFEEXTERNO, PSUPERVEXTERNO
employeeBranchFilial do empregadoString
RA_FILIAL
PFUNC.CODFILIAL
employeeCodeMatrícula do empregadoString
RA_MAT
PFUNC.CHAPA
employeeNameNome do empregadoString
RA_
PPESSOA.NOME
employeeFullNameNome completo do empregadoString
RA_NOMECMP

Exemplos de requisição e retorno:

...

Requisição

...

Retorno

...

Explicação

...

 Expandir origem

...

 Expandir origem

...

 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"
        }
    ]
}

...

 Expandir origem

...

PPESSOA.NOME


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.
400
Nenhum 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á.

...