Serviço externo padrão MentorWeb - Inclusão de cronograma

Serviço externo do Mentor que realiza a inclusão de cronograma.
Para saber mais sobre serviços externos .

Nome do serviço externo: incluirCronogramaAula

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 se não informado os 3 parâmetros (periodoLetivoId,turmaCod,disciplinaCod)
periodoLetivoId Identificador do período letivo Condicional Integer Obrigatório se não informado o parâmetro turmaDisciplinaId
turmaCod Código da turma Condicional TEXTO Obrigatório se não informado o parâmetro turmaDisciplinaId
disciplinaCod Código da disciplina Condicional TEXTO Obrigatório se não informado o parâmetro turmaDisciplinaId
gerarCronogramaEmFeriados Quando “sim” irá gerar cronograma em feriados Sim Integer 1 = SIm / 0 = Não
validaDisponibilidade Quando “sim” irá validar disponibilidade do docente Sim Integer 1 = SIm / 0 = Não
listCronorgamaIncluir Lista de dados para geração do cronograma Sim LIsta
regimeDisciplina Regime da disciplina Sim Integer Ex.: NORM = Normal / QUIN = Quinzenal / …
dataInicialAula Data inicial para geração do cronograma Sim Date Formato: dd/mm/yyyy
dataFinalAula Data final para geração do cronograma Sim Date Formato: dd/mm/yyyy
diaSemana Dia da semana Sim Integer DOM = 1 / SEG = 2 / TER = 3 / QUA = 4 / QUI = 5 / SEX = 6 / SAB = 7
repeticoes Repetições Não Integer Utilizado no cronograma com processo de seleção de docente
horarioId Identificador do horário Sim Integer
tipoAula Tipo da aula Sim String Tipos permitidos: TEORICA / PRATICA
subTurmaId Identificador da subturma Não Integer
professorId Identificador do professor Não Integer
professorSubstituto Professor substituto Sim Integer 1 = Sim / 0 = Não
salaId Identificador da sala Não Integer
horarioCompartilhado Horário compartilhado Sim Integer 1 = Sim
horarioConfirmado Horário confirmado Sim Integer 1 = Sim
horarioEspecial Horário especial Sim Integer 1 = Sim
valorPagamento Valor do pagameno Não BigDecimal

2. Exemplo de chamada do Serviço

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


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

{
  "validaDisponibilidade" : 1,
  "turmaDisciplinaId" : 462827,
  "gerarCronogramaEmFeriados" : 0,
  "listCronorgamaIncluir" : [ {
    "horarioEspecial" : 0,
    "diaSemana" : 1,
    "repeticoes" : null,
    "subTurmaId" : null,
    "horarioCompartilhado" : 0,
    "tipoAula" : "TEORICA",
    "horarioId" : 247,
    "professorSubstituto" : 0,
    "horarioConfirmado" : 1,
    "dataInicialAula" : "16/02/2020",
    "professorId" : 10099619,
    "regimeDisciplina" : "NORM",
    "dataFinalAula" : "16/02/2020",
    "valorPagamento" : null,
    "salaId" : null
  } ]
}

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.

Atenção: O retorno emitido pelo webservice é log completo referente a inclusão de cronograma, da forma em que está gravado no banco de dados. Se for necessário, deve-se tratar o retorno para remover os caracteres especiais, como por exemplo, a barra invertida.

Exemplo de retorno Json:

Sucesso - Status code 200: 

{
    "valor": "{\"log\":[\"SUCESSO - Turma: 01-N-M/1101-511 e Disciplina: Bioética\",\"SUCESSO -   Definido o professor \\\"10097783 -  vanessa de Fatima da Silva\\\" como responsável.\",\"SUCESSO -   Foram incluídos 1 cronogramas de aulas.\",\"SUCESSO - \\u003cdiv style\\u003d\\\"padding-left: 0px; padding-top: 8px; font-weight: bold; font-size: 12px;\\\"\\u003eTotal de cronogramas de aulas incluídos: 1\\u003c/div\\u003e\",\"COM_ADVERTENCIAS - Turma: 01-N-M/1101-511 e Disciplina: Bioética, foi incluído cronograma aula com as seguintes restrições:\",\"COM_ADVERTENCIAS -   A disciplina atualmente está com 3,00 horas aulas, é esperado 40 horas aulas para a mesma.\",\"COM_ADVERTENCIAS -   O(A) professor(a) \\\"10097783 -  vanessa de Fatima da Silva\\\" não está apto a lecionar a disciplina.\"]}",
    "resultado": "SUCESSO"
}
  • (edição externa)