Histórico da Página

...

A API receberá os seguintes query params:

Query Param	Descrição	Obrigatório	Tipo
companyId	Código do grupo de empresas para filtro	Sim	String
branchId	Código da filial do empregado para filtro	Sim	String
page	Página que está sendo requisitada	Não	Integer
pageSize	Quantidade de registros por página	Não	Integer
employeeCode	Código da matrícula do empregado para filtro	Não	String
employeeCostCenterCode	Código do centro de custo do(s) empregado(s) para filtro	Não	String
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

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

PSECAO.CODFILIAL
managerCode	Matrícula do líder	String

RA_MAT

PSUBSTCHEFE.CHAPASUBST, PSUBSTSUP.CHAPASUBST, PCHEFEEXTERNO.CODEXTERNO, PSUPERVEXTERNO.CODEXTERNO
managerName	Nome do líder	String

RA_

PPESSOA.NOME
managerFullName	Nome completo do líder	String

RA_NOMECMP

PPESSOA.NOME
managerEmail	E-mail do líder	String

RA_

PPESSOA.EMAIL
managerDepartmentCode	Código do departamento do líder	String

RA_DEPTO

PSECAO.CODSECAO
managerDepartmentDescription	Descrição do departamento do líder	String

QB_DESCRIC

PSECAO.DESCRICAO
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

PFUNC.CODCCUSTO
employeeBranch	Filial do empregado	String

RA_FILIAL

PFUNC.CODFILIAL
employeeCode	Matrícula do empregado	String

RA_MAT

PFUNC.CHAPA
employeeName	Nome do empregado	String

RA_

PPESSOA.NOME
employeeFullName	Nome completo do empregado	String

RA_NOMECMP

PPESSOA.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ágina

http://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 408081

http://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
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

...

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 8

Nova versão 9

Chave

04. DEMAIS INFORMAÇÕES

05. ASSUNTOS RELACIONADOS