Editar dados de pré-admissões — APIs da Admissão Digital

Edita uma pré-admissão existente. A API valida as informações da requisição e substitui as informações da pré-admissão com os dados que foram enviados na requisição.

Definições da API:

URL
Cabeçalho
Parâmetros
Exemplo
Respostas

URL

POST <url_plataforma>/t/senior.com.br/bridge/1.0/rest/hcm/onboardingintegration/actions/preAdmissionUpdate

Substitua<url_plataforma>*pela URL correspondente ao seu ambiente. Se for o ambiente de produção, substitua por:*https://platform.senior.com.br

Cabeçalho (Header)

Authorization	Bearer <access_token>
Content-Type	application/json

Substitua<access_token>pela chave de acesso obtida a partir da API de autenticação na plataforma.

Parâmetros

* Obrigatórios

Parâmetro	Tipo	Descrição
preAdmissionId *	String	Identificador único da pré-admissão.
employeeName	String	Nome a ser atualizado no cadastro do colaborador.
admissionDate	Date	Data de admissão a ser atualizada no cadastro do colaborador.
company { }		Informações da empresa. Você pode obter estas informações pelo retorno da API companyQuery.
branchOffice { }		Informações da filial. Você pode obter estas informações pelo retorno da API branchOfficeQuery.
area { }		Informações da área (local). Você pode obter estas informações pelo retorno da API areaListQuery.
jobPosition { }		Informações do cargo. Você pode obter estas informações pelo retorno da API jobPositionQuery.
customFields { }		Campos customizados criados no modelo de convite de pré-admissão.

company:

Campo	Tipo	Descrição
id	String	Identificador único da empresa.
companyName	String	Nome da empresa.
code	String	Código do sistema externo.

Nota

Você pode obter estas informações pelo retorno da API companyQuery.

branchOffice:

Campo	Tipo	Descrição
id	String	Identificador único da filial.
branchOfficeName	String	Razão social da filial.
tradingName	String	Nome fantasia da filial.
code	String	Código do sistema externo.

Nota

Você pode obter estas informações pelo retorno da API branchOfficeQuery.

area:

Campo	Tipo	Descrição
id	String	Identificador único da área (local).
name	String	Nome da área (local).
code	String	Código do sistema externo.

Nota

Você pode obter estas informações pelo retorno da API areaListQuery.

jobPosition:

Campo	Tipo	Descrição
id	String	Identificador único do cargo.
name	String	Nome do cargo.
code	String	Código do sistema externo.

Nota

Você pode obter estas informações pelo retorno da API jobPositionQuery.

customFields:

Parâmetro	Tipo	Descrição
field	String	Identificador do campo customizado criado na Senior X.
value		Recebe o valor preenchido no campo. O tipo do campo `value` será o mesmo tipo que foi definido durante a criação do campo customizado na Senior X.

Exemplo

{
  "preAdmissionId": "1747ffb8-3250-4409-a7ca-2688af714f02",
  "employeeName": "José da Silva",
  "admissionDate": "2022-01-01",
  "company": {
    "id": "88e53115-91a6-4e13-bb58-384e882c6839",
    "companyName": "Senior Sistemas",
    "code": "1"
  },
    "branchOffice": {
      "id": "1c638493-6b55-4882-9dbc-6d60c9aa2c1a",
      "branchOfficeName": "Senior Filial S/A",
      "tradingName": "Senior Filial",
      "code": "4"
    },
    "customFields": [
      {
        "field": "usu_custom",
        "value": "Valor 1"
      },
      {
        "field": "usu_custom1",
        "value": "Valor 2"
      },
      {
        "field": "usu_custom2",
        "value": "Valor 3"
      }
    ]
}

Respostas

Código

Descrição

Campos da resposta

200

Ok (indica que a pré-admissão foi atualizada)

Campo	Tipo	Descrição
result	Boolean	Indicativo se a atualização dos dados foi bem sucedida ou não.

401

Invalid credentials

default

Error response

Campo	Tipo	Descrição
message	String	Mensagem descritiva do erro.
reason	String	Um código que representa a categoria da causa do erro.

PORTAL DE DOCUMENTAÇÃO
Gestão de Pessoas \| HCM - senior X