Verificação de diário

Este tópico lista as características do WebService Json de verificação de diário de classe. Este método deverá ser chamado para retornar verificar se o diário de classe está apto para receber alterações, como por exemplo o cadastro de avaliação ou até mesmo a gravação das notas dos alunos.
As validações realizadas por este WebService são:

  • Prazo de avaliação do diário;
  • Prazo de digitação do diário;
  • Fechamento do diário.

Nome do método: realizaVerificacaoPeriodoDiarioClasse

Parâmetros para chamada do WebService

Parâmetro Descrição Obrigatório Tipo Observação
idTurmaDisciplina Identificador da turma/disciplina Não * Integer Informar o identificador da turma/disciplina no MentorWeb
codigoIntegracao Código de integração da turma/disciplina Não * String Informar o código de integração da turma/disciplina (caso o MentorWeb tenha conhecimento deste código)
idTipoNota Identificador do tipo de nota Sim Integer Informar qual é o tipo de nota para realizar a verificação do diário (verificar método recuperaTipoNotaPorTurmaDisciplina)
dataInicial Data inicial do período de avaliação/digitação Não Data (DD/MM/YYYY) Informar a data inicial do período de avaliação/digitação.
Quando informado, será verificado se esta data é igual ou superior a data de início do período de avaliação/digitação. caso seja, está dentro do período de avaliação/digitação desde que a data final (se informada) também esteja.
dataFinal Data final do período de avaliação/digitação Não Data (DD/MM/YYYY) Informar a data final do período de avaliação/digitação.
Quando informado, será verificado se esta data é igual ou anterior a data final do período de avaliação/digitação. caso seja, está dentro do período de avaliação/digitação desde que a data inicial (se informada) também esteja.
* Pelo menos um dos parâmetros é obrigatório. O MentorWeb vai utilizar apenas um dos valores, na ordem informada.


Atributos retornados do WebService para o chamador

Campo Descrição Tipo Observação
codigoRetornoIntegracao Código do retorno da integração Integer Código de retorno da integração. Verifique a lista de códigos possíveis.
descricaoRetornoIntegracao Descrição do retorno da integração String Quando ocorrer sucesso, a descrição será: Sucesso.
Quando ocorrer um erro, a descrição será o erro ocorrido, com possíveis detalhes.
observacaoRetornoIntegracao Observação do retorno da integração String Quando ocorre erro, este campo poderá conter informações importantes para identificar o problema.


Possíveis retornos para o chamador do WebService

Código Descrição Observação
ICA_00000 Sucesso Obteve sucesso na chamada e retorno do WebService.
ICA_00400 Parâmetros inválidos Ocorre quando são passados parâmetros inválidos para a execução do método.
Exemplo: Passar uma String onde está sendo solicitado Integer, ou até mesmo não passar nenhum parâmetro.
Solução: Verificar a documentação do WebService e conferir os parâmetros que estão sendo passados.
ICA_00401 Nenhuma informação encontrada Ocorre quando não foi encontrada nenhuma informação para os parâmetros informados.
ICA_00411 Diário fechado Ocorre quando já foi realizado o fechamento do diário
ICA_00417 Fora do prazo de avaliação Ocorre quando o diário está fora do prazo de avaliação
ICA_00418 Fora do prazo de digitação Ocorre quando o diário está fora do prazo de digitação


Exemplo de chamada do WebService

URL: http://IP:PORTA/APLICACAO/rest/ICorujaACA/realizaVerificacaoDiarioDeClasse

Exemplo da passagem de parâmetros por Json: 

ctx:{"usuario": 28}
idTurmaDisciplina:38501
codigoIntegracao:null
idTipoNota:42
codigoIntegracao:null
codigoIntegracao:null

Atenção: O parâmetro usuario deve ser solicitado para a instituição de ensino. Orientamos a instituição a criar um usuário com o nome da empresa que está fazendo a integração.

Exemplo de chamada do WebService na linguagem PHP 

<?php
header("Content-Type: text/html; charset=utf-8");
$curl = curl_init();
 
//realizar o urlencode de cada VALOR de parâmetro. O valor de cada parâmetro já deve estar no formato Json pra fazer o urlencode.
$paramCtx = "ctx=".urlencode('{"usuario":28}');
$idTurmaDisciplina = "idTurmaDisciplina=null";
$codigoIntegracao = "codigoIntegracao=".urlencode('"852"');
$idTipoNota = "idTipoNota=".urlencode(42);
$dataInicial = "dataInicial=null";
$dataFinal = "dataFinal=null";
 
$parametros = $paramCtx."&".$idTurmaDisciplina."&".$codigoIntegracao."&".$idTipoNota."&".$dataInicial."&".$dataFinal;
 
curl_setopt_array($curl, array(
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://192.168.0.66:8080/ICoruja/rest/ICorujaACA/realizaVerificacaoDiarioDeClasse",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => $parametros,
  CURLOPT_HTTPHEADER => array(
    "cache-control: no-cache",
    "content-type: application/x-www-form-urlencoded",
    "postman-token: 2635cd9e-ae8b-2db0-92d0-3eba7b19524c"
  ),
));
 
$response = curl_exec($curl);
$err = curl_error($curl);
 
curl_close($curl);
 
if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
?>

Exemplo de retorno do WebService: 

//Exemplo: caso de sucesso (ou seja, pode alterar o diário)
{
    "codigoRetornoIntegracao":"ICA_00000",
    "descricaoRetornoIntegracao":"Sucesso.",
    "observacaoRetornoIntegracao":""
}
 
 
 
//Exemplo: caso de não poder realizar alteração no diário
{
    "codigoRetornoIntegracao":"ICA_00418",
    "descricaoRetornoIntegracao":"Fora do período de digitação.",
    "observacaoRetornoIntegracao":"O diário está fora do período de digitação."
}
  • (edição externa)