01. VISÃO GERAL
Este documento apresenta os parâmetros de entrada e o retorno da API de GET de pessoas candidatas.
02. ENDPOINT E PARÂMETROS DE ENTRADA
Endpoint da API que será utilizado para inserir e atualizar dados:
| URL base | Endpoint |
|---|---|
| https://api-centraldorecrutador.totvs.app/recruitment-integration | {URL base}/api/v1/talent-bank/get-all |
2.1 - DADOS ENVIADOS
Não é necessário realizar o envio de nenhum dado.
Retorno:
| Campos | Descrição | Possíveis valores* | ||
|---|---|---|---|---|
| fullName | Nome completo da pessoa candidata | texto (string) | ||
| applicantType | Forma como a pessoa candidata entrou no banco de talentos | Enum de inteiros 1 - Via processo de candidatura 2 - Manual com convite 3 - Manual sem convite | ||
personalInformation | gender | Sexo da pessoa candidata | Enum de inteiros 0 - Feminino 1 - Masculino 2 - Prefere não responder | |
| pronoun | Pronome da pessoa candidata | Enum de inteiros 0 - Ela/Dela 1 - Ele/Dele 2 - Prefere não responder | ||
| genderIdentity | Gê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 | ||
| colorOrEthnicity | Cor/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 | ||
| sexualOrientation | Orientação Sexual da pessoa candidata | Enum de inteiros 0 - Heterosexual 1 - Homosexual 2 - Bisexual 3 - Asexual 4 - Prefere não responder | ||
disability | physical | A pessoa candidata possui deficiência física? | true ou false (boolean) | |
| visual | A pessoa candidata possui deficiência visual? | |||
| auditory | A pessoa candidata possui deficiência auditiva? | |||
| intellectual | A pessoa candidata possui deficiência intelectual? | |||
| multiple | A pessoa candidata possui deficiência múltipla? | |||
| autismSpectrum | A 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 | name | Nome da empresa | texto (string) | |
positions | name | Nome do cargo | texto (string) | |
| startDate | Data de início | data (Date) | ||
| endDate | Data de término | data (Date) | ||
| description | Descrição das atividades | texto (string) | ||
| current | A pessoa candidata trabalha aqui atualmente? | true ou false (boolean) | ||
| E-mail da pessoa candidata | texto (string) | |||
| birthday | Data de nascimento da pessoa candidata | data (Date) | ||
| age | Idade da pessoa candidata | número (int) | ||
jobApplications | title | Nome da vaga em que a pessoa candidata se candidatou | texto (string) | |
| publicationDate | Data 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 iniciada 4 - Admissão cancelada | ||
isInternal | A pessoa candidata já trabalha na empresa em que se candidatou a vaga? | true ou false (boolean) | ||
| isRecommendation | A pessoa candidata foi indicada? | true 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) | ||
| applicationDate | Data da candidatura | data (Date) | ||
address | cep | CEP da pessoa candidata | texto (string) | |
| cityName | Cidade da pessoa candidata | texto (string) | ||
| stateName | Estado da pessoa candidata | texto (string) | ||
| latestCVUpdate | Data da última atualização do currículo | data (Date) | ||
| registrationDate | Data do cadastro da pessoa candidata no sistema | data (Date) | ||
IMPORTANTE
* 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.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas