Serviço externo padrão MentorWeb - Serviço de carga de pessoas
Nome do serviço externo: consultaPessoasSituacao
Disponibilizado um serviço para ser instalado no servidor da catraca.
Este serviço, destinado a softwares ou aplicativos externos, realiza a atualização da lista de alunos e professores ativos ou não ativos no ambiente. Os parâmetros necessários para esse serviço são o tipo da pessoa e sua situação.
1. Parâmetros para chamada do serviço externo
| Parâmetro | Descrição | Obrigatório | Tipo | Observação |
|---|---|---|---|---|
| tipoPessoa | Tipo de pessoa consultada | Sim | Texto | ALUNO = Alunos ALUNO_RESPONSAVEL = Alunos e responsáveis PROFESSOR_FUNCIONARIO = Professores e funcionários TODOS = Ambos |
| situacaoPessoa | Situação da pessoa consultada | Sim | Texto | ATIVOS = Somente ativos INATIVOS = Somente inativos TODOS = Ambos |
| unidade | Unidade da turma | Não | Numérico | id da unidade |
Com base nos parâmetros, deve-se identificar alunos e/ou professores cadastrados no sistema:
- Primeira validação (Alunos): Com a identificação da pessoa, deve-se 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. Caso informada a unidade, considerar somente turmas da unidade.
- 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, deve-se 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. Caso informada a unidade, considerar somente turmas da unidade.
- Quarta validação (Funcionários) Com a identificação da pessoa, deve-se 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.
- Alunos com a situação da matrícula diferente de “ATIVO” são considerados inativos.
- Professores retornados em que possuam data de demissão informada no histórico de ocupações são considerados inativos.
O serviço então deve retornar:
| Campo | Informação | Observação |
|---|---|---|
| codigoPessoa | PES_CODTEL | Trazer todos os dados conforme cadastro. |
| nomePessoa | PES_NOME | Trazer todos os dados conforme cadastro. |
| nomeCivil | PES_NOMCIV | Trazer todos os dados conforme cadastro. |
| fotoPessoa | HASH DA FOTO | Trazer todos os dados conforme cadastro. |
O serviço deve ser padrão, solicitado por método GET e deve possuir validação por token.
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 consultaPessoasSituacao, deve ser gerado a chave de Autorização para saber mais clique aqui. (Aqui deve ser informado a Collection e como gerar o jwttoken Dev Andrey estava criando o documento)
- Para facilitar as configurações via Postman clique aqui para baixar a Collection, lembrando de alterar os registros conforme cada instituição.
- Authorization
Exemplo da Url: https://IP:PORTA/APLICACAO_API/v1/controlefrequencia/consultaPessoasSituacao
Como deve ficar: https://qualidademssql.edusoft.inf.br/quaMssqlApi/v1/controlefrequencia/consultaPessoasSituacao
- Headers
- Body
