Pessoa

  • Fri, 10/22/2021 - 11:23
  • /vitor.goncalves...

(GET) employeejourney/entities/person

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

Uma "person", para o HCM, é uma entidade que representam as informações pessoais das pessoas cadastradas. Algumas dessas informações são seu nome, CPF, data de nascimento, endereço, meios de contato, grau de instrução e outras características pessoais do indivíduo. Estas informações podem ser visualizadas pelo colaborador na tela de Meu Perfil no módulo do Painel de Gestão.

Esse endpoint é utilizado para obter as informações das pessoas cadastradas 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 pessoa consiste de:

{ "id": id da pessoa, "firstname": primeiro nome, "middlename": nome do meio, "lastname": último nome, "fullName": nome completo, "socialname": nome/razão social, "nickname": apelido, "birthday": data de nascimento, "gender": gênero, "maritalstatus": estado civil, "race": cor, "cpf": número CPF, "nis": [ { "id": identificador do documento, "number": número de identificação do segurado(PIS/PASEP/NIT), "registrationDate": data de registro do documento } ] "emails": [ { "id": identificador do e-mail, "email": endereço de e-mail, "emailType": tipo de e-mail } ] "nationality": { "id": id da nacionalidade, "name": descrição nacionalidade, "code": código G5 da nacionalidade }, "naturality": { "id": id da naturalidade, "name": nome da cidade de nascença, "state": { "id": id do estado de nascença, "abbreviation": abreviação do nome do estado, "name": nome do estado de nascença } } "educationDegree": { "id": id do grau de educação, "name": descrição do grau de educação, "code": código G5 do grau de educação }, "phoneContact": [ { "id": id telefone de contato, "countryCode": código do país, "localCode": código local, "number": número telefone, "phoneContactType": tipo do telefone } ], "addresses": [ id do endereço da pessoa ], "disabilities": [ { "id": id , "disability": { "id": id deficiência, "code": código G5 deficiência, "name": descrição deficiência, "type": tipo da deficiência }, "mainDisability": indica se é a deficiência principal da pessoa, "isRehabilitated": indica se a pessoa está reabilitada da deficiência, "dateWhen": data do acontecimento } ], "phoneContacts": [ { "id": id a lista de telefone de contatos, "carrier": operadora, "countryCode": código do país, "localCode": código da região, "number": número telefone, "extention": operadora, "phoneContactType": tipo do telefone } ] }

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

Todos os campos do payload da API são possíveis de usar no filtro, com exceção do campo fullName. Caso você queira filtrar pelo nome do colaborador é necessário usar os atributos firstName, middleName ou lastName da entidade person.

Casos de uso:

  • Buscar todas as pessoas cadastradas no sistema:

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

  • Buscar todas as pessoas que possuem um endereço cadastrado:

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

  • Buscar os endereços de todas as pessoas que possuem o endereço em uma determinada cidade:

    .../person?filter=addresses.id is not null and addresses.city.name='nomedacidade'

  • Buscar pessoa pelo primeiro nome:

    .../person?filter=firstname='Primeiro Nome'

  • Buscar pessoa pelo CPF:

    .../person?filter=cpf='númeroCpf'

  • Buscar todas as pessoas com determinado grau de ensino usando containing:

    .../person?filter=containing(educationDegree.name, 'nome grau de educação')

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

    .../person?size=2&offset=0&orderby=firstname

  • Filtrando por gênero:

    .../person?filter=gender eq 'FEMALE'

  • Filtrando por telefone:

    .../person?filter=phoneContact.number='numero de telefone'

  • Buscar somente os ids e grau de educação das pessoas:

    .../person?displayfields=educationDegree.name

  • Buscar todas as pessoas que possuem email pessoal cadastrado:

    .../person?filter=emails.email is not null

  • Buscar todas as pessoas que nasceram em um estado específico:

    .../person?filter=naturality.state.abbreviation eq 'SC'