Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Este documento apresenta os parâmetros de entrada e o retorno da API de GET de estadospessoas candidatas.

02. ENDPOINT E PARÂMETROS DE ENTRADA

Endpoint da API que será utilizado para inserir e atualizar dados:

URL baseEndpoint
https://api-centraldorecrutador.dev.totvs.app/recruitment-integration/swagger{URL base}/api/v1/talent-bank/get-all


2.1 - PARÂMETROS OPCIONAIS DA CONSULTA

  • Page: Número da página a ser buscada
    • Valor padrão quando não presente na consulta é 1
  • PageSize: Tamanho da página de registros a serem buscadas
    • Valor padrão quando não presente na consulta é 5

Exemplo de URL com ambos os parâmetros:

Informações
titleIMPORTANTE

Tamanho máximo de uma pagina é de 50. Se for enviado um valor maior será enviado somente 50 registros.


2.2 - DADOS ENVIADOS 

Não é necessário realizar o envio de nenhum dado.

Retorno:

...

CamposDescriçãoPossíveis valores*
fullNameNome completo da pessoa candidata
-
texto (string)
applicantTypeForma como a pessoa candidata entrou no banco de talentos 

Enum de inteiros

Automatic

1 - Via processo de candidatura

ManualWithInvite

2 - Manual com convite

ManualWithoutInvite

3 -

 

Manual sem convite











personalInformation




genderSexo da pessoa candidata

Enum de inteiros

0 - Feminino

1 - Masculino

2 - Prefere não responder

pronounPronome da pessoa candidata

Enum de inteiros

0 - Ela/Dela

1 - Ele/Dele

2 - Prefere não responder

genderIdentityGênero da pessoa candidata

Enum de inteiros

0 - Cisgênero

1 - Transgênero

2 - Não-binário

3 - Agênero

4 - Prefere não responder

colorOrEthnicityCor/Raça/Etnia da pessoa candidata

Enum de inteiros

0 - Branco

1 - Amarelo 

2 - Preto

3 - Pardo

4 - Indígena

5 - Prefere não responder

sexualOrientationOrientação Sexual da pessoa candidata

Enum de inteiros

0 - Heterosexual

1 - Homosexual

2 - Bisexual

3 - Asexual

4 - Prefere não responder






disability

physicalA pessoa candidata possui deficiência física?





true ou false (

verdadeiro

boolean)

false (false)

visualA pessoa candidata possui deficiência visual?
auditoryA pessoa candidata possui deficiência auditiva?
intellectualA pessoa candidata possui deficiência intelectual?
multipleA pessoa candidata possui deficiência múltipla?
autismSpectrumA pessoa candidata possui transtorno de espectro autista?









education









Escolaridade da pessoa candidata

Enum de inteiros

0 - Ensino médio completo

1 - Superior completo

2 - Superior incompleto

3 - Pós-graduação completa

4 - Pós-graduação incompleta

5 - Mestrado

6 - Doutorado

7 - Ensino médio incompleto

8 - Ensino fundamental completo

9 - Ensino fundamental incompleto

10 - Ensino fundamental em andamento

11 - Ensino médio em andamento

12 - Superior em andamento

13 - Pós-graduação em andamento

14 - Mestrado em andamento

15 - Doutorado em andamento

16 - Mestrado incompleto

17 - Doutorado incompleto

18 - Técnico completo

19 - Técnico em andamento

20 - Técnico incompleto



professionalExperiences

nameNome da empresa
-
texto (string)



positions

nameNome do cargo
-
texto (string)
startDateData de início
-

data (Date)

endDateData de término
-
data (Date)
descriptionDescrição das atividades
-
texto (string)
currentA pessoa candidata trabalha aqui atualmente?

true ou false (

verdadeiro

boolean)

ou false (false)

emailE-mail da pessoa candidata
-
texto (string)
birthdayData de nascimento da pessoa candidata
-
data (Date)
ageIdade da pessoa candidata
-
número (int)





jobApplications

titleNome da vaga em que a pessoa candidata se candidatou
-
texto (string)
publicationDateData de publicação da vaga
-
data (Date)



howFindJobOpportunity

Como a pessoa candidata encontrou a vaga

Enum de inteiros

0 - Linkedin

1 - Página de carreiras

2 - Redes sociais

3 - Google

4 - Outros


otherChannels

Caso a pessoa candidata tenha escolhido a opção Outros no campo anterior, este campo apresentará o texto digitado pela pessoa candidata
-
texto (string)



status


Status da pessoa candidata na vaga

Enum de inteiros

0 - Ativo

1 - Contratado

2 - Reprovado

3 - Admissão

em andamento

iniciada

4 - Admissão cancelada

isInternal

A pessoa candidata já trabalha na empresa em que se candidatou a vaga?

true ou false (

verdadeiro

boolean)

ou false (false)

isRecommendationA pessoa candidata foi indicada? true
(verdadeiro) ou false (false
ou false (boolean)


recomentadionEmail

Caso a pessoa candidata tenha sido indicada, este campo trará o e-mail da pessoa que fez a indicação
-
texto (string)
applicationDateData da candidatura
-
data (Date)


address

cepCEP da pessoa candidata
-
texto (string)
cityNameCidade da pessoa candidata
-
texto (string)
stateNameEstado da pessoa candidata
-
texto (string)
latestCVUpdateData da última atualização do currículo
-
data (Date)
registrationDateData do cadastro da pessoa candidata no sistema
-
data (Date)
Painel
Informações
titleIMPORTANTE

 * Todos os campos podem retornar com o valor null, o que significa que o mesmo ainda não possui valor. 


Observação: Os dados da API representam somente os candidatos que são apresentados no banco de talentos.

Exemplo: Caso haja alguma inserção manual direto em uma vaga a pessoa candidata talvez não seja apresentada na listagem do banco de talentos até o convite seja aceito, a API também não irá retornar essa pessoa.