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

Método disponibilizado pelo Contratanet, para o Cliente consumir.


Nome do método:

CreateCandidate


Url do método:

https://www.PORTALDAINSTITUICAO.com.br/integration/candidate/CreateCandidate


Utilização:

Será utilizado para cadastrar, automaticamente, novos usuários nos portal de vagas.

O Contratanet será chamado para cadastrar um novo usuário, e chamará o método Recuperar dados do usuário, para recuperar os dados do mesmo.


Quando será chamado:

Sempre que o Cliente quiser cadastrar automaticamente um novo usuário no portal de vagas.

Dependências:


O cadastro do usuário, depende da criação do método Recuperar dados do usuário.


O Contratanet espera receber os seguintes parâmetros:


E retornará o seguinte paramêtro:

Parâmetros de Envio (Cliente)
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...
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
Parâmetros de Retorno (Contratanet)
Termo Tipo do campo Nome do parâmetro Significado
Status da criação do usuário * string creationStatus Informa se o usuário foi cadastrado. Possíveis respostas:
Código Descrição
Success Usuário cadastrado com sucesso
Error Ocorreu algum erro ao cadastrar o usuário
Mensagens de erro string array errorList Array com todas as mensagens de erro, caso ocorram.
Carregando...