• qua, 09/21/2022 - 18:07
  • /jaime.cafure@se...

(GET) employeejourney/entities/department

https://api.senior.com.br/hcm/employeejourney/entities/department

Um "department", para o HCM, é uma entidade que representam as informações de departamentos cadastrados - mesmo sem colaboradores vinculados. Algumas dessas informações são: ID, nome, posição, endereço, data de criação, código de tabela, código, data de histórico e data de expiração. Estas informações podem ser visualizadas pelo colaborador na tela de Departamentos, no módulo do Painel de Gestão.

Esse endpoint é utilizado para obter as informações dos departamentos cadastrados na base do HCM. Todos os endpoints do serviço da jornada do colaborador só podem ser acessados por usuários ou aplicações com o (permissionamento correto ), com um limite máximo de 100 itens por página de retorno. Campos não preenchidos não são retornados.

O payload de cada departamento consiste em:

{ "id": "Id departamento", "tableCode": código da tabela, "code": "código do departamento cadastrado", "position": "Posição", "name": "Nome do departamento", "creationDate": "data de criação", "historicExpirationDate": "Histórico de expiração", "address": { "id": "idEndereço", "additional": "complemento", "neighborhood": "Bairro", "address": "endereço", "city": { "id": "id da cidade", "name": "Nome da cidade", "state": { "id": "Id do Estado", "abbreviation": "Abreviação do Estado ex: SC", "name": "Nome do estado" }, "code": Código } } }

**Os IDs retornados pelas APIs são os IDs utilizados pelos serviços acoplados ao Painel de Gestão, de modo que eles não são necessariamente consistentes em todos os serviços oferecidos pelo HCM.

Uso dos filtros:

É possível filtrar os resultados seguindo estas diretivas. Observe nos casos de uso que é possível utilizar filtros de atributos internos da entidade Address.

Casos de uso:

  • Buscar todos os departamentos cadastrados no sistema:

    https://api.senior.com.br/hcm/employeejourney/entities/department

  • Buscar todos os departamentos que possuem um endereço cadastrado:

    .../department?filter=address.id is not null

  • Buscar os endereços de todos os departamentos que possuem o endereço em uma determinada cidade:

    .../department?filter=address.id is not null and address.city.name='nomedacidade'

  • Buscar departamento pelo nome:

    .../department?filter=name='Nome'

  • Buscar departamento pelo código:

    .../department?filter=code='codigo'

  • Buscar todos os departamentos com determinado nome usando containing:

    .../department?filter=containing(name, 'nome departamento')

  • Filtrando por quatidade de retorno por página usando ordenação:

    .../department?size=2&offset=0&orderby=name

  • Buscar departamento utilizando somente o campo nome:

    .../department?displayfields=name

  • Buscar todos os departamentos que estão em um estado específico:

    .../department?filter=address.city.state.abbreviation='SC'