• sex, 10/22/2021 - 10:26
  • /vitor.goncalves...

(GET) employeejourney/entities/address

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

Um "address", para o HCM, representa todos os endereços cadastrados, ou seja, tanto os endereços pessoais dos colaboradores quanto os endereços de empresas cadastrados aparecem nessa listagem. As informações do endereço do colaborador podem ser visualizadas no campo Endereço da tela Meu Perfil do módulo do Painel de Gestão.

Esse endpoint é utilizado para obter os endereços 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 e possuem 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 endereço consiste de:

{ "id": id do endereço "address": logradouro/rua do endereço "additional": informação adicional referente ao endereço "neighborhood": bairro/distrito do endereço "city": { "id": id da cidade "name": nome da cidade "code": código G5 da cidade "state": { "id": id do estado onde se localiza a cidade "abbreviation": abreviação do nome do estado "name": nome do estado "code": código G5 do estado } } "person": id da pessoa que possui este endereço** }

**Como a tabela de endereços é compartilhada entre todas as ocorrências possíveis de um endereço no HCM, para que somente os endereços de colaboradores sejam retornados, é possível adicionar como parâmetro na URI da API o filtro: "?filter=person.id is not null".

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 Person.

Casos de uso:

  • Buscar todos os endereços cadastrados no sistema:

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

  • Buscar todos os endereços de pessoas cadastrados:

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

  • Buscar os endereços de todas as pessoas que possuem o endereço em um determinado bairro:

    .../address?filter=person.id is not null and city.name='nomedacidade' and neighborhood='nomedobairro'

  • Buscar o endereço de uma pessoa específica:

    .../address?filter=person.id='id da pessoa'

  • Buscar o endereço da pessoa com o sobrenome 'sobrenome':

    .../address?filter=containing(person.lastname, 'sobrenome')

  • Buscar todos os endereços e ordenar por ordem alfabética reversa do nome da cidade, com 12 endereços por página, buscando a segunda página do conjunto:

    .../address?orderby=city.state.name+desc&size=12&offset=1

  • Buscar somente os ids e o nome da cidade de todos os endereços cadastrados:

    .../address?displayfields=id,city.name