Integração Usuário - Recuperar situação do usuário

← 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:

GetCandidateSituation


Url do método:

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


Utilização:

Será utilizado para controlar o acesso do usuário ao portal e verificar a necessiade de atualizar os dados do mesmo.


Quando será chamado:

Sempre que o usuário efetuar o login no sistema, sem utilizar a integração de Login, com o Cliente.

Isso ocorre, quando ele faz o login utilizando as credenciais cadastradas no Contratanet, ou via integração com LinkedIn ou Facebook.


Dependências:


A atualização dos dados do usuário, depende da criação do método Recuperar dados do usuário.


O Contratanet enviará os seguintes parâmetros:


E espera como retorno os seguintes dados:

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
Sitação do usuário* string userSituation Será utilizada para controlar o acesso dos usuários ao portal de vagas.
Possíveis situações do usuário:
Código Descrição
Active Usuário está ativo e pode usar o sistema
Inactive Usuário está inativo e não pode usar o sistema
Restrict Usuário está restrito e não pode utilizar algumas das funcionalidades do sistema
Motivo da situação string reason Motivo do usuário estar Restrict ou Inactive.
Data da última atualização date lastChangeDate Deve ser informada a data da última atualização dos dados do usuário (dados pessoais, de endereço ou acadêmicos), no sistema do Cliente.
A data deve estar no formato ISO 8601. Exemplo: "1980-03-21"
Essa informação será utilizada pelo Contratanet para saber se deve ou não chamar o método Recuperar dados do usuário e atualizar os dados no Contratanet. Para não gerar tráfego desnecessário, nos servidores do Cliente, o Contratanet só chamará o método para atualizar os dados do usuário, caso a data da última alteração seja maior do que a data da última requisição feita.
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...