Serviço externo padrão MentorWeb - Serviço de liberação de acesso
Nome do serviço externo: validaEntradaSaidaPadrao
Disponibilizado um serviço para realizar a validação de acesso de alunos, responsáveis, professores e demais funcionários.
Este serviço recebe como parâmetro o código do usuário. Com base nesse código, verifica nas configurações gerais do controle de frequência o formato do campo de identificação da pessoa. A seguir, identifica a pessoa em questão e verifica se o acesso pode ser liberado.
1. Parâmetros para chamada do serviço externo
Parâmetro | Descrição | Obrigatório | Tipo | Observação |
---|---|---|---|---|
codigoUsuario | Código do usuário | Sim | Alfanumérico | Sem máscara |
Após identificar a pessoa, verifica-se o valor. Se o valor for “Alunos”, realiza-se apenas a primeira validação. Se o valor for “Alunos, responsáveis, professores e funcionários”, são realizadas as quatro validações.
- Primeira validação (Alunos): Com a identificação da pessoa, devemos primeiramente verificar se a mesma é aluno ativo. A pessoa será considerada aluno ativo ao identificar uma matrícula com situação = “ATIVO” no qual a data atual esteja entre as datas inicial e final da turma principal da matrícula.
- Segunda validação (Responsáveis): Com a identificação da pessoa, deve-se primeiramente verificar se seu cadastro está ativo. A pessoa será considerada responsável quando estiver vinculada como pai, mãe, responsável pedagógico ou responsável financeiro a um aluno ativo que deve possuir uma matrícula com situação = “ATIVO” no qual a data atual esteja entre as datas inicial e final da turma principal da matrícula. Caso informada a unidade, considerar somente turmas da unidade.
- Terceira validação (Professores): Com a identificação da pessoa, devemos primeiramente verificar se a mesma é professor ativo. A pessoa será considerada professor ativo ao identificar que o mesmo possui vínculo de cronograma de aula com as disciplinas de uma turma em que a data atual esteja entre a data inicial e final da turma.
- Quarta validação (Funcionários): Com a identificação da pessoa, devemos primeiramente verificar se a mesma é funcionário ativo. A pessoa será considerada funcionário ativo ao identificar que o mesmo possui ao menos um registro de ocupação vinculado ao seu cadastro de pessoa física em que a data de demissão não esteja informada ou seja maior que a data atual.
O serviço então deve retornar:
Campo | Informação | Observação |
---|---|---|
Retorno | Liberado/Negado | Liberado = Identificada matrícula ativa ou registro de cronograma em turma ativa, Negado = Não identificada pessoa ou não identificada matrícula ativa ou registro de cronograma em turma ativa. |
Instruções para realizar a chamada
- Para realizar as chamadas dos endpoints via API, segue as configurações necessárias, lembrando que o exemplo de endereço /api/ pode variar de cliente para cliente conforme seu domínio.
- Primeiro antes de executar o serviço externo validaEntradaSaidaPadrao, deve ser gerado a chave de Autorização para saber mais clique aqui. (Aqui deve ser informado a Collection e como gerar o jwttoken)
- Para facilitar as configurações via Postman clique aqui para baixar a Collection, lembrando de alterar os registros conforme cada instituição.
- Authorization
- Headers
- Body