Histórico da Página
01. VISÃO GERAL
Este documento apresenta os parâmetros de entrada e o retorno da API de GET de candidaturascandidatura.
02. ENDPOINT E PARÂMETROS DE ENTRADA
Endpoint da API que será utilizado para inserir e atualizar dados:
| URL base | Endpoint |
|---|---|
| https://api-centraldorecrutador.dev.totvs.app/recruitment-integration/swagger |
| {URL base}/api/v1/job-application/search |
12.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 |
| Informações |
|---|
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 | jobOpportunity.code | Código da vaga ATS | jobOpportunity.||
| internalClientCode | Código da vaga (interno ERP) | |||
| title | Título da vaga | jobOpportunity.|||
| jobOpportunityType | TipoLista dos tipos da vaga |
| ||
| invitationLanguage | Idioma do convite | jobOpportunity.|||
facility | .name | Nome unidade (Filial) | jobOpportunity.||
| cnpj | CNPJ unidade | jobOpportunity.facility.|||
| stateSmallName | Estado (UF) | |||
| cityName | Cidade | jobOpportunity.facility.|||
| stateName | Estado | |||
| integrationId | Código unidade (interno ERP) | |||
department | .name | Nome da área/departamento | jobOpportunity.department.||
| integrationId | Código da área/departamento (interno ERP) | |||
| position | .name | Nome do cargo | jobOpportunity.position.||
| integrationId | Código do cargo (interno ERP) | |||
| isCLT | Regime de contratação CLT | jobOpportunity.|||
| isPJ | Regime de contratação Pessoa jurídica | |||
| IsInternship | Regime de contratação Estágio | |||
| fullName | Nome do candidato | |||
| applicant.id | Código do candidato | |||
| applicant.cpf | CPF do candidato | |||
| applicant.email | E-mail do candidato | |||
| applicant.birthday | Data de nascimento | |||
| applicant.telephoneNumber | Telefone | |||
| applicant.zipCode | CEP | |||
| applicant.address | Endereço | |||
| applicant.cityName | Cidade | |||
| applicant.stateName | Estado | |||
| applicant.gender | Gênero | |||
| isFreelancer | Regime de contratação Freelancer | |||
| isCooperated | Regime de contratação Cooperado | applicant.diversity | Deficiência||
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas