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 |
Retorno:
| Campo | Descrição |
|---|---|
| integrationId | ID único de integração |
| hiringDate | Data de contratação |
| jobOpportunity.code | Código da vaga ATS |
| jobOpportunity.internalClientCode | Código da vaga (interno ERP) |
| jobOpportunity.title | Título da vaga |
| jobOpportunity.jobOpportunityType | Tipo da vaga |
| jobOpportunity.invitationLanguage | Idioma do convite |
| jobOpportunity.facility.name | Nome unidade (Filial) |
| jobOpportunity.facility.cnpj | CNPJ unidade |
| jobOpportunity.facility.stateSmallName | Estado (UF) |
| jobOpportunity.facility.cityName | Cidade |
| jobOpportunity.facility.integrationId | Código unidade (interno ERP) |
| jobOpportunity.department.name | Nome da área/departamento |
| jobOpportunity.department.integrationId | Código da área/departamento (interno ERP) |
| jobOpportunity.position.name | Nome do cargo |
| jobOpportunity.position.integrationId | Código do cargo (interno ERP) |
| jobOpportunity.isCLT | Regime de contratação CLT |
| jobOpportunity.isPJ | Regime de contratação Pessoa jurídica |
| jobOpportunity.IsInternship | Regime de contratação Estágio |
| jobOpportunity.isFreelancer | Regime de contratação Freelancer |
| jobOpportunity.isCooperated | Regime de contratação Cooperado |
| 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 |
| applicant.diversity | Deficiência |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas