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

Versões comparadas

Chave

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

...

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.

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




visionCodeCódigo da visão contendo a estrutura hierárquica quando utilizado o parâmetro MV_ORGCFG com 1 ou 2Nã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 as seguintes propriedades:

Propriedade

Descrição

Tipo

Origem do valor

managerBranchFilial do líderStringRA_FILIAL
managerCodeMatrícula do líderStringRA_MAT
managerNameNome do líderStringRA_NOME
managerFullNameNome completo do líderStringRA_NOMECMP
managerEmailE-mail do líderStringRA_EMAIL
managerDepartmentCodeCódigo do departamento do líderStringRA_DEPTO
managerDepartmentDescriptionDescrição do departamento do líderStringQB_DESCRIC
managerCostCenterCodeCódigo do centro de custo do líderStringRA_CC
managerCostCenterDescriptionDescrição do centro de custo do líderStringCTT_DESC01
employeeBranchFilial do empregadoStringRA_FILIAL
employeeCodeMatrícula do empregadoStringRA_MAT
employeeNameNome do empregadoStringRA_NOME
employeeFullNameNome completo do empregadoStringRA_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

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

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.




04. DEMAIS INFORMAÇÕES

Exemplo de configuração do REST.


05. ASSUNTOS RELACIONADOS

Não há.



05. DEMAIS INFORMAÇÕES