Registrar desistências e reabilitar candidatos — APIs da Admissão Digital

Esta API permite o registro de desistências de candidatos a uma vaga e também a reabilitação de candidatos que previamente desistiram.

Definições da API:

URL

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

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)

Content-Type

application/json

Parâmetros

* Obrigatórios

Parâmetro

Tipo

Descrição

preAdmissionId *

String

ID da pré-admissão que será registrado a desistência ou reabilitação, deve ser um ID válido pertencente a uma pré-admissão existente na base.

enumWithdrawal *

String

Valor que define se o candidato desistiu da vaga ou reabilitou-se, os valores possíveis para esse campo são: WITHDRAWAL e NO_WITHDRAWAL, ao informar um valor diferente disso, será retornado erro.

reason

String

Campo texto para informar o motivo da desistência/reabilitação.

Exemplo

{
  "preAdmissionld": "a2477d50-49b4-4b75-958b-3e8d80221433",
  "enumWithdrawal": "NO_WITHDRAWAL",
  "reason": "Teste"
}

Resposta

O resultado desta chamada deverá ser semelhante a isto:

Código

Descrição

Campos da resposta

Tipo

Descrição

200

Ok - resultado do envio da desistência/reabilitação

ok

Boolean

Indicativo se o envio foi bem sucedido ou não

message

String

Mensagem de retorno da primitiva

idPreAdmission

String

Identificador da pré-admissão

401

Invalid credentials

default

Error response

message

String

Mensagem descritiva do erro

reason

String

Código que representa a categoria da causa do erro

Este artigo ajudou você?