Tabela de conteúdos

Serviço externo padrão MentorWeb - Encerrar diário por turma/disciplina

Serviço externo do Mentor que realiza o encerramento de diário de uma turma/disciplina, ou agrupamento.
Para saber mais sobre serviços externos .

Nome do serviço externo: encerrarDiarioTurmaDisciplina

Para saber 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

Parâmetro Descrição Obrigatório Tipo Observação
turmaDisciplinaId Identificador da turma/disciplina Condicional Integer Obrigatório quando não informado o identificador do agrupamento de turma/disciplina
agrupamentoTurmaDisciplinaId Identificador do agrupamento de turma/disciplina Condicional Integer Obrigatório quando não informado o identificador de turma/disciplina
validaDisponibilidade tipoNotaId Sim Integer Identificador da avaliação do critério de avaliação
aulasDadas Quantidade de aulas dadas Sim Integer Deve-se informar a quantidade de aulas dadas a ser considerado
Se não for informado, não será gravado aulas dadas. É recomendado informar este campo.


2. Exemplo de chamada do Serviço

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


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

{
   "turmaDisciplinaId":27099,
   "agrupamentoTurmaDisciplinaId":null,
   "tipoNotaId":215,
   "aulasDadas":60
}


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.

Exemplo de retorno Json:
Sucesso - Status code 200:


{
    "valor": "Encerramento do diário efetuado com sucesso",
    "resultado": "SUCESSO"
}


Exemplo de Erro - (neste caso, status diferente de 200):

{
    "resultado": "ERRO",
    "erro": {
        "operacao": "br.com.edusoft.mentorweb.servico.controller.ServicoExternoAcademicoImplJava.encerrarDiarioTurmaDisciplina",
        "valores": "{\r\n   \"turmaDisciplinaId\":27099,\r\n   \"agrupamentoTurmaDisciplinaId\":null,\r\n   \"tipoNotaId\":215,\r\n   \"aulasDadas\":null\r\n}",
        "motivo": "EduClientLogProcessoException: Diário já fechado para o tipo de nota/disciplina!"
    }
}