DT API para retornar líder direto dos empregados

01. DADOS GERAIS

Produto:	TOTVS RH
Linha de Produto:	Linha Protheus
Segmento:	RH
Módulo:	SIGAGPE
Função:	GPEA010APIB
Ticket:
Requisito/Story/Issue (informe o requisito relacionado) :	DRHCALCPRT-9345 DRHCALCPRT-9750

02. SITUAÇÃO/REQUISITO

Efetuar a criação de uma API para retornar a lista do líder direto dos empregados, semelhante a API employeeDataContent que retorna a lista dos empregados.

03. SOLUÇÃO

Implementada a API employeesManagerDataContent que irá retornar uma lista contendo o líder direto dos empregados, semelhante a API employeeDataContent que retorna a lista dos empregados.

Observação

A estrutura hierárquica utilizada para verificar o líder do empregado possui a mesma configuração que é utilizada no Portal de Gestão de Capital Humano e no Meu RH, através da configuração de departamentos, postos e/ou visão.

Para mais informações, consulte as documentações a seguir: https://tdn.totvs.com/x/LYx9Hg , https://tdn.totvs.com/x/dfryHQ e https://tdn.totvs.com/x/kfvRHQ.

A API receberá os seguintes query params:

Query Param	Descrição	Obrigatório	Tipo	Valor padrão	Valor de exemplo
companyId	Código do grupo de empresas para filtro	Sim	String		01
branchId	Código da filial do empregado para filtro	Sim	String		0101
page	Página que está sendo requisitada	Não	Integer	1	1
pageSize	Quantidade de registros por página	Não	Integer	2000	100
employeeCode	Código da matrícula do empregado para filtro	Não	String	""	000100
employeeCostCenterCode	Código do centro de custo do(s) empregado(s) para filtro	Não	String	""	1.01.01
visionCode	Código da visão contendo a estrutura hierárquica quando utilizado o parâmetro MV_ORGCFG com 1 ou 2	Não	String	""	00001

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

A propriedade items contém as seguintes propriedades:

Propriedade	Descrição	Tipo	Origem do valor
managerBranch	Filial do líder	String	RA_FILIAL
managerCode	Matrícula do líder	String	RA_MAT
managerName	Nome do líder	String	RA_NOME
managerFullName	Nome completo do líder	String	RA_NOMECMP
managerEmail	E-mail do líder	String	RA_EMAIL
managerDepartmentCode	Código do departamento do líder	String	RA_DEPTO
managerDepartmentDescription	Descrição do departamento do líder	String	QB_DESCRIC
managerCostCenterCode	Código do centro de custo do líder	String	RA_CC
managerCostCenterDescription	Descrição do centro de custo do líder	String	CTT_DESC01
employeeBranch	Filial do empregado	String	RA_FILIAL
employeeCode	Matrícula do empregado	String	RA_MAT
employeeName	Nome do empregado	String	RA_NOME
employeeFullName	Nome completo do empregado	String	RA_NOMECMP

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 { "hasNext": false, "total": 8, "items": [ { "managerBranch": "", "managerCode": "", "managerName": "", "managerFullName": "", "managerEmail": "", "managerDepartmentCode": "", "managerDepartmentDescription": "", "managerCostCenterCode": "", "managerCostCenterDescription": "", "employeeBranch": "L MG 01 ", "employeeCode": "408074", "employeeName": "CEO", "employeeFullName": "CEO" }, { "managerBranch": "L MG 01 ", "managerCode": "408074", "managerName": "CEO", "managerFullName": "CEO", "managerEmail": "[email protected]", "managerDepartmentCode": "999999901", "managerDepartmentDescription": "PRESIDENCIA", "managerCostCenterCode": "1 ", "managerCostCenterDescription": "DIRETORIA", "employeeBranch": "L MG 01 ", "employeeCode": "408075", "employeeName": "VP", "employeeFullName": "VP" }, { "managerBranch": "L MG 01 ", "managerCode": "408075", "managerName": "VP", "managerFullName": "VP", "managerEmail": "[email protected]", "managerDepartmentCode": "999999902", "managerDepartmentDescription": "VICE PRESIDENCIA", "managerCostCenterCode": "1 ", "managerCostCenterDescription": "DIRETORIA", "employeeBranch": "L MG 01 ", "employeeCode": "408076", "employeeName": "DIRETORA EXECUTIVA", "employeeFullName": "DIRETORA EXECUTIVA" }, { "managerBranch": "L MG 01 ", "managerCode": "408076", "managerName": "DIRETORA EXECUTIVA", "managerFullName": "DIRETORA EXECUTIVA", "managerEmail": "[email protected]", "managerDepartmentCode": "999999903", "managerDepartmentDescription": "DIRETORIA EXECUTIVA", "managerCostCenterCode": "1 ", "managerCostCenterDescription": "DIRETORIA", "employeeBranch": "L MG 01 ", "employeeCode": "408077", "employeeName": "DIRETORA", "employeeFullName": "DIRETORA" }, { "managerBranch": "L MG 01 ", "managerCode": "408077", "managerName": "DIRETORA", "managerFullName": "DIRETORA", "managerEmail": "[email protected]", "managerDepartmentCode": "999999904", "managerDepartmentDescription": "DIRETORIA", "managerCostCenterCode": "1 ", "managerCostCenterDescription": "DIRETORIA", "employeeBranch": "L MG 01 ", "employeeCode": "408078", "employeeName": "GESTORA EXECUTIVA", "employeeFullName": "GESTORA EXECUTIVA" }, { "managerBranch": "L MG 01 ", "managerCode": "408078", "managerName": "GESTORA EXECUTIVA", "managerFullName": "GESTORA EXECUTIVA", "managerEmail": "[email protected]", "managerDepartmentCode": "999999905", "managerDepartmentDescription": "GERENCIA EXECUTIVA", "managerCostCenterCode": "1.01 ", "managerCostCenterDescription": "ADMINISTRACAO", "employeeBranch": "L MG 01 ", "employeeCode": "408079", "employeeName": "GESTORA", "employeeFullName": "GESTORA" }, { "managerBranch": "L MG 01 ", "managerCode": "408079", "managerName": "GESTORA", "managerFullName": "GESTORA", "managerEmail": "[email protected]", "managerDepartmentCode": "999999906", "managerDepartmentDescription": "GERENCIA", "managerCostCenterCode": "1.01 ", "managerCostCenterDescription": "ADMINISTRACAO", "employeeBranch": "L MG 01 ", "employeeCode": "408080", "employeeName": "COORDENADORA", "employeeFullName": "COORDENADORA" }, { "managerBranch": "L MG 01 ", "managerCode": "408080", "managerName": "COORDENADORA", "managerFullName": "COORDENADORA", "managerEmail": "[email protected]", "managerDepartmentCode": "999999907", "managerDepartmentDescription": "SQUAD", "managerCostCenterCode": "1.01.01 ", "managerCostCenterDescription": "FOLHA DE PAGAMENTO", "employeeBranch": "L MG 01 ", "employeeCode": "408081", "employeeName": "ANALISTA", "employeeFullName": "ANALISTA" } ] }	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 { "hasNext": true, "total": 8, "items": [ { "managerBranch": "", "managerCode": "", "managerName": "", "managerFullName": "", "managerEmail": "", "managerDepartmentCode": "", "managerDepartmentDescription": "", "managerCostCenterCode": "", "managerCostCenterDescription": "", "employeeBranch": "L MG 01 ", "employeeCode": "408074", "employeeName": "CEO", "employeeFullName": "CEO" }, { "managerBranch": "L MG 01 ", "managerCode": "408074", "managerName": "CEO", "managerFullName": "CEO", "managerEmail": "[email protected]", "managerDepartmentCode": "999999901", "managerDepartmentDescription": "PRESIDENCIA", "managerCostCenterCode": "1 ", "managerCostCenterDescription": "DIRETORIA", "employeeBranch": "L MG 01 ", "employeeCode": "408075", "employeeName": "VP", "employeeFullName": "VP" }, { "managerBranch": "L MG 01 ", "managerCode": "408075", "managerName": "VP", "managerFullName": "VP", "managerEmail": "[email protected]", "managerDepartmentCode": "999999902", "managerDepartmentDescription": "VICE PRESIDENCIA", "managerCostCenterCode": "1 ", "managerCostCenterDescription": "DIRETORIA", "employeeBranch": "L MG 01 ", "employeeCode": "408076", "employeeName": "DIRETORA EXECUTIVA", "employeeFullName": "DIRETORA EXECUTIVA" }, { "managerBranch": "L MG 01 ", "managerCode": "408076", "managerName": "DIRETORA EXECUTIVA", "managerFullName": "DIRETORA EXECUTIVA", "managerEmail": "[email protected]", "managerDepartmentCode": "999999903", "managerDepartmentDescription": "DIRETORIA EXECUTIVA", "managerCostCenterCode": "1 ", "managerCostCenterDescription": "DIRETORIA", "employeeBranch": "L MG 01 ", "employeeCode": "408077", "employeeName": "DIRETORA", "employeeFullName": "DIRETORA" }, { "managerBranch": "L MG 01 ", "managerCode": "408077", "managerName": "DIRETORA", "managerFullName": "DIRETORA", "managerEmail": "[email protected]", "managerDepartmentCode": "999999904", "managerDepartmentDescription": "DIRETORIA", "managerCostCenterCode": "1 ", "managerCostCenterDescription": "DIRETORIA", "employeeBranch": "L MG 01 ", "employeeCode": "408078", "employeeName": "GESTORA EXECUTIVA", "employeeFullName": "GESTORA EXECUTIVA" }, { "managerBranch": "L MG 01 ", "managerCode": "408078", "managerName": "GESTORA EXECUTIVA", "managerFullName": "GESTORA EXECUTIVA", "managerEmail": "[email protected]", "managerDepartmentCode": "999999905", "managerDepartmentDescription": "GERENCIA EXECUTIVA", "managerCostCenterCode": "1.01 ", "managerCostCenterDescription": "ADMINISTRACAO", "employeeBranch": "L MG 01 ", "employeeCode": "408079", "employeeName": "GESTORA", "employeeFullName": "GESTORA" } ] }	Retorno dos empregados e respectivos líderes da empresa T2 e filial L MG 01 , com paginação de 6 registros por página
http://localhost:8060/rest/rh/v1/employeesManagerDataContent?companyId=T2&branchId=L MG 01 &employeeCode=408081	Expandir origem { "hasNext": false, "total": 1, "items": [ { "managerBranch": "L MG 01 ", "managerCode": "408080", "managerName": "COORDENADORA", "managerFullName": "COORDENADORA", "managerEmail": "[email protected]", "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 408081
http://localhost:8060/rest/rh/v1/employeesManagerDataContent?companyId=T2&branchId=L MG 01 &employeeCostCenterCode=1.01.01	Expandir origem { "hasNext": false, "total": 2, "items": [ { "managerBranch": "L MG 01 ", "managerCode": "408079", "managerName": "GESTORA", "managerFullName": "GESTORA", "managerEmail": "[email protected]", "managerDepartmentCode": "999999906", "managerDepartmentDescription": "GERENCIA", "managerCostCenterCode": "1.01 ", "managerCostCenterDescription": "ADMINISTRACAO", "employeeBranch": "L MG 01 ", "employeeCode": "408080", "employeeName": "COORDENADORA", "employeeFullName": "COORDENADORA" }, { "managerBranch": "L MG 01 ", "managerCode": "408080", "managerName": "COORDENADORA", "managerFullName": "COORDENADORA", "managerEmail": "[email protected]", "managerDepartmentCode": "999999907", "managerDepartmentDescription": "SQUAD", "managerCostCenterCode": "1.01.01 ", "managerCostCenterDescription": "FOLHA DE PAGAMENTO", "employeeBranch": "L MG 01 ", "employeeCode": "408081", "employeeName": "ANALISTA", "employeeFullName": "ANALISTA" } ] }	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
400	O parâmetro companyId é obrigatório.	Preencher o parâmetro companyId.
400	O 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
500	Ocorreu uma falha no retorno da informação.

04. DEMAIS INFORMAÇÕES

Exemplo de configuração do REST.

05. ASSUNTOS RELACIONADOS

Não há.

Árvore de páginas