← Voltar para a tela de visualização de APIs
Descrição

Este método deve ser implementado pelo Cliente e será consumido pelo Contratanet.


Nome do método:

GetCandidateData


Url do método:

https://www.SITEDOCLIENTE.com.br/CAMINHOPARAOSERVICO/GetCandidateData


Utilização:

É utilizado para atualizar ou cadastrar os dados pessoais, dados de endereço e dados acadêmicos do usuário.
Estes dados são fornecidos pelo sistema do Cliente.


Quando será chamado:

Sempre que houver alguma alteração nos dados do usuário.
Esta alteração, será controlada pela Data da última atualização, que é recebida pelos métodos Recuperar situação do usuário e Login.

Sempre que o método de Criação do Usuário, for chamado pelo Cliente.
Ele irá atualizar os dados, caso o usuário já exista, ou cadastrar o usuário, caso não exista.


Dependências:


A atualização dos dados do usuário, depende do recebimento da data da última atualização, que é um dos parâmetros esperados nos métodos Recuperar situação do usuário e Login.

O cadastro automático de usuários de um cliente, no portal de vagas, depende do método Criação do usuário, que é o gatilho para esta ação.


O Contratanet enviará os seguintes parâmetros:


E espera como retorno os seguintes dados do usuário:

Parâmetros de Envio (Contratanet)
Termo Tipo do campo Nome do parâmetro Significado
Login do usuário * string userIdentifier Identificação escolhida pelo cliente para poder validar os seus usuário. Exemplo: CPF, RA + ID da Instituição, etc...
Parâmetros de Retorno (Cliente)
Termo Tipo do campo Nome do parâmetro Significado
Dados pessoais * object userData
Termo Tipo do campo Nome do parâmetro Significado
Nome * string userName Nome completo do usuário que está sendo cadastrado
E-mail * string userEmail E-mail do usuário
Sexo string userSex Masculino (M) ou Feminino (F)
Data de nascimento date userBirthDate Data de nascimento do usuário no formato ISO 8601. Exemplo: "1980-03-21"
Telefone string userPhone Telefone do usuário.
Celular string userMobilePhone Celular do usuário.
CPF string userCpf CPF do usuário sem caracteres especiais.
Dados de endereço * object userAddress
Termo Tipo do campo Nome do parâmetro Significado
Logradouro string addressDescription Nome da Rua, Av. ou praça do endereço de residência do usuário
Número int addressNumber Número do endereço de residência do usuário
Complemento string addressCompletion Complemento do endereço de residência do usuário
Bairro string addressNeighbord Bairro do endereço de residência do usuário
CEP string addressZip CEP do endereço de residência do usuário
Cidade * string addressCity Cidade do endereço de residência do usuário
UF * string addressState UF do endereço de residência do usuário. Ex: RJ, SP, MG.
Dados acadêmicos * array object adademicData
Termo Tipo do campo Nome do parâmetro Significado
Matrícula * string registrationNumber Código de matrícula do usuário no curso
Código do Curso * string userCourseCode Código do curso do usuário, na instituição de ensino
Caso o curso correspondete ao código já exista no sistema, ele será utilizado.
Caso contrário, será cadastrado um novo curso, utilizado o Nome do curso recebido.
Nome do curso * string userCourseName Nome completo do curso do usuário
Código da instituição * string userInstitutionCode Código da instituição do usuário, na instituição de ensino.
Caso a instituição correspondete ao código já exista no sistema, ela será utilizada.
Caso contrário, será cadastrado uma nova instituição, utilizado o Nome da Instituição recebido.
Nome da Instituição * string userInstitutionName Nome completo da Instituição de Ensino ou Campus do usuário
Código do Campus * string userCampusCode OBS: Usado na integração que possui multi-hierarquia (instituição e campus). Código do campus no cliente (IES).
Caso o campus correspondente ao código já exista no sistema, ela será utilizada.
Caso contrário, será cadastrado um novo campus, utilizado o Nome do Campus recebido.
Nome do Campus * string userCampusName OBS: Usado na integração que possui multi-hierarquia (instituição e campus).
Nome completo do Campus do usuário
Período int userGrade Período atualmente cursado pelo usuário
Data de previsão de formatura / Data de formatura * string graduateDate Data de formatura do usuário no formato mm/AAAA. Caso a data seja maior que a atual (MÊS/ANO), consideraremos o estudante como formado; caso contrário, consideraremos como data prevista de formatura.
Turno do estudante string userTurn Possíveis turnos do usuário:
Código Descrição
I Turno integral
M Turno da manhã
T Turno da tarde
N Turno da noite
V Virtual
Versão utilizada * string version Será enviado o código da versão da API. Este será utilizada pelo Contratanet, para manter a retrocompatibilidade, caso a API seja atualizada.
Versão atual: V1.0
Lista de erros string array errorList Array com todas as mensagens de erro, caso ocorram.
Carregando...