01. VISÃO GERAL
Este documento apresenta os parâmetros de entrada e o retorno da API de GET de candidatura.
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/job-application/search |
2.1 - DADOS ENVIADOS
Parâmetro | Descrição |
|---|---|
| jobOpportunityStatus | Filtrar pelo status da vaga (Padrão é status Publicado) |
| jobApplicationStatus | Filtrar pelo status da candidatura (Padrão é status Contratado) |
| jobApplicantId | Filtrar pelo identificador do candidato |
| jobApplicationChangeStatus | Filtrar para pegar todos os candidatos com data de alteração posterior a informada |
| page | Número da página que deseja obter os dados |
Somente candidatos na etapa de Contratação serão retornados pela API.
Retorno:
| Campo | Descrição | ||
|---|---|---|---|
| integrationId | ID único de integração | ||
| hiringDate | Data de contratação | ||
| fullName | Nome do candidato | ||
| socialName | Nome Social | ||
applicant | id | Código do candidato | |
| cpf | CPF do candidato | ||
| E-mail do candidato | |||
| birthday | Data de nascimento | ||
| telephoneNumber | Telefone | ||
address | zipCode | CEP | |
| cityName | Cidade | ||
| stateName | Estado | ||
| stateSmallName | Estado Abreviado | ||
| street | Rua | ||
| complement | Complemento | ||
| neighborhoodName | Bairro | ||
| gender | Sexo | ||
| genderIdentity | Identidade de Gênero | ||
| pronoun | Pronomes | ||
diversity | physical | Deficiência Física | |
| visual | Deficiência visual | ||
| auditory | Deficiência auditiva | ||
| intellectual | Deficiência intelectual | ||
| multiple | Deficiência múltipla | ||
| autismSpectrum | Possui autismo | ||
jobOpportunity | code | Código da vaga ATS | |
| internalClientCode | Código da vaga (interno ERP) | ||
| title | Título da vaga | ||
| jobOpportunityType | Lista dos tipos da vaga | ||
| invitationLanguage | Idioma do convite | ||
facility | name | Nome unidade (Filial) | |
| cnpj | CNPJ unidade | ||
| stateSmallName | Estado (UF) | ||
| cityName | Cidade | ||
| stateName | Estado | ||
| integrationId | Código unidade (interno ERP) | ||
department | name | Nome da área/departamento | |
| integrationId | Código da área/departamento (interno ERP) | ||
| position | name | Nome do cargo | |
| integrationId | Código do cargo (interno ERP) | ||
| isCLT | Regime de contratação CLT | ||
| isPJ | Regime de contratação Pessoa jurídica | ||
| IsInternship | Regime de contratação Estágio | ||
| isFreelancer | Regime de contratação Freelancer | ||
| isCooperated | Regime de contratação Cooperado | ||
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas