Serviço externo padrão MentorWeb - Matricula aluno conforme filtros

Serviço externo do Mentor que realiza matricula conforme filtros.
Para saber mais sobre serviços externos clique aqui.

Nome do serviço externo: matriculaAlunoConformeFiltros

Para ver como montar a URL de chamada para esse serviço externo, acesse a página referente à execução de serviços externos clicando aqui.

1. Parâmetros para chamada do serviço externo

Identificação da turma
Parâmetro	Descrição	Obrigatório	Tipo	Observação
Identificação da pessoa
pessoaCpf	CPF do aluno	Não	Texto
pessoaEmail	Email do aluno	Não	Texto
pessoaId	ID do aluno	Não	Númerico

turmaCodTel	Código da turma	Não	Texto
cursoCodTel	Código do curso	Não	Texto
periodoLetivoId	ID do periodo letívo	Não	Numérico
turno	Turno	Não	Texto	Exemplo: “M” - Matutino, “N” - Noturno
semestreLetivo	Semestre letivo	Não	Numérico
cursoId	ID do curso	Não	Numérico
anoLetivo	Ano letivo	Não	Numérico
dataInicioTurma	Data de início da turma	Não	Data
turmaId	ID da turma	Não	Numérico
turmaUnidadeId	Unidade	Não	Numérico

Dados do ingresso
statusMatriculaIngresso	Status da matrícula	Sim	Texto	Status permitidos: “ATIVO”, “PREMAT” e “CANCEL”.
dataMatricula	Data da matrícula	Não	Data	Se não for informada, utiliza a data atual.
formaIngressoId	ID da forma de ingresso	Não	Numérico	Se não for informado, utiliza a forma de ingresso padrão configurada nas regas de matrículas.

Financeiro
realizaAcaoFinanceira	Se realiza ação financeira ao cancelar	Sim	Numérico	1 - Sim, 0 - Não.

1.1. Observações

Identificação da pessoa: Pelo menos um dos filtros para a identificação da pessoa deve ser informado.

Identificação da turma:
Regra 1: Para a identificação da turma é obrigatório informar pelo menos um dos seguintes parâmetros: ID da unidade ou ID da turma.
Regra 2: Se o o ID da turma não for informado, deve ser informado pelo menos um dos seguintes parâmetros: Ano letivo ou ID do período letivo.
Regra 3: Se o ID da turma não for informado, porém o ano letivo ou o ID do período letivo forem, é possível utilizar os demais parâmetros para filtrar as turmas disponíveis para a matrícula.
Regra 4: Se a pesquisa retornar mais de uma turma, a matrícula será efetuada na primeira retornada.

Importante: caso a instituição possua configurado documentos obrigatórios para as periodicidades cadastro/ingresso ou matrícula, e na regra de matrícula estiver configurado para utilizar a opção bloqueia por pendência de documento, será necessário enviar no campo “statusmatriculaingresso” a opção “PREMAT”, e efetivar a matrícula via secretaria na entrega de documentos. Se nas configurações citadas acima enviar o valor ATIVO no campo “statusmatriculaingresso” o sistema não realizará a matrícula do aluno retornando um erro com a seguinte mensagem: “Matrícula Bloqueada! Existem documentos obrigatórios para matrícula pendentes”

Financeiro (Cancelamento de parcela):
Regra 1: Para inativar as parcelas junto ao cancelamento da matrícula deve ser configurado nas Regras de matrícula > Aba Cancelamento um motivo de cancelamento no novo campo de “Motivo padrão para cancelamento de parcela (serviço externo)”, a ação a ser tomada para as parcelas ao cancelar e definir o parâmetro realizaAcaoFinanceira como 1.
Regra 2: Mesmo que esteja configurado na regra de matrícula uma ação ao cancelar, se enviado o parâmetro realizaAcaoFinanceira como 0, nenhuma ação será realizada nas parcelas.

2. Exemplo de chamada do Serviço pelo postman

URL: http://IP:PORTA/APLICACAO/rest/servicoexterno/execute/matriculaAlunoConformeFiltros

2.1. Exemplo da passagem de parâmetros por Json:

{
   "turmaCodTel" : null,
   "pessoaCpf" : null,
   "cursoCodTel" : null,
   "periodoLetivoId" : 149,
   "turno" : "M",
   "formaIngressoId" : null,
   "turmaUnidadeId" : 1,
   "semestreLetivo" : null,
   "fase" : null,
   "pessoaId" : 2379,
   "statusMatriculaIngresso" : "PREMAT",
   "dataMatricula" : null,
   "cursoId" : null,
   "realizaAcaoFinanceira" : 0,
   "pessoaEmail" : null,
   "anoLetivo" : null,
   "dataInicioTurma" : null,
   "turmaId" : 67
}

3. Retorno do serviço (Json)

Para obter o retorno do serviço deve-se verificar o status da requisição http. Sempre que o status for 200, significa que o processo foi realizado com sucesso.

Exemplos de retorno Json:

Sucesso - Status code 200:

{
    "mestreAlunoId": 514270,
    "contratoFinanceiroId": 725106,
    "ingressoId": 207131,
    "pessoaId": 1503,
    "periodoLetivoId": 133,
    "turmaId": 287,
    "cursoId": 195,
    "resultado": "SUCESSO"
}

Com erro - Status code 509:

{
   "resultado": "ERRO",
      "erro": {
        "operacao": "br.com.edusoft.mentorweb.servico.controller.ServicoExternoAcademicoImplJava.matriculaAlunoConformeFiltros",
        "valores": "{\r\n  \"turmaCodTel\" : null,\r\n  \"pessoaCpf\" : null,\r\n  \"cursoCodTel\" : null,\r\n  \"periodoLetivoId\" :      null,\r\n  \"turno\" : null,\r\n  \"formaIngressoId\" : null,\r\n  \"turmaUnidadeId\" : 1,\r\n  \"semestreLetivo\" : null,\r\n  \"fase\" : null,\r\n  \"pessoaId\" : null,\r\n  \"statusMatriculaIngresso\" : \"PREMAT\",\r\n  \"dataMatricula\" : null,\r\n  \"cursoId\" : null,\r\n  \"realizaAcaoFinanceira\" : 0,\r\n  \"pessoaEmail\" : \"[email protected]\",\r\n  \"anoLetivo\" : null,\r\n         \"dataInicioTurma\" : null,\r\n  \"turmaId\" : null\r\n} ",
        "motivo": "EduBaseRuntimeException: É obrigatório informar o parâmetro \"turmaId\", \"anoLetivo\" ou \"periodoLetivoId\", no     parâmetro \"filtroTurma\"
       }
}