Consulta de critério de avaliação da turma/disciplina

Este tópico lista as características do WebService Json de consulta de critério de avaliação da turma/disciplina.
Este método deverá ser chamado para retornar o critério de avaliação de uma determinada turma/disciplina. Junto com o critério de avaliação, é retornada a lista com os tipos de notas e suas respectivas configurações. Como exemplo de tipos de nota, pode-se citar: bimestre, trimestre, semestre, dentre outros.

Nome do método: consultaCriterioAvaliacaoPorTurmaDisciplina

Parâmetros para chamada do WebService

Atributos retornados do WebService para o chamador

Possíveis retornos para o chamador do WebService

Exemplo de chamada do WebService

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

Atenção: No cabeçalho da requisição http deverá ser enviado o parâmetro token. Esse parâmetro deverá conter a chave de token cadastrada no MentorWeb. Hoje esta chave já é utilizada.

Exemplo da passagem de parâmetros por Json:

{
    "codigoUnidade":9,
    "idTurmaDisciplina":null,
    "codigoIntegracao":"852",
    "tipoNotaRetornar":null
}

Exemplo de chamada do WebService na linguagem PHP

<?php
 
$curl = curl_init();
 
curl_setopt_array($curl, array(
    CURLOPT_PORT => "8080",
    CURLOPT_URL => "http://localhost:8080/ICoruja/rest/ICorujaACA/consultaCriterioAvaliacaoPorTurmaDisciplina",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_POSTFIELDS => '{"codigoUnidade":9,"idTurmaDisciplina":null,"codigoIntegracao":"852","tipoNotaRetornar":null}',
    CURLOPT_HTTPHEADER => array(
        "cache-control: no-cache",
        "content-type: application/json",
        "postman-token: 74e6008c-0675-fb7c-87d0-23adcbeddd9a",
        "token: 49gcd881cr2158g971849z1faze755x7"
    )
));
 
$response = curl_exec($curl);
$err      = curl_error($curl);
 
curl_close($curl);
 
if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
 
?> 

Exemplo do retorno do WebService Json:

{
  "codigoRetornoIntegracao": "ICA_00000",
  "descricaoRetornoIntegracao": "Sucesso.",
  "observacaoRetornoIntegracao": null,
  "idPacronizacaoDisciplina": 15,
  "descricaoCriterioAvaliacao": "Graduação 2011 Oficial",
  "tipoDigitacaoNota": "ZERO_DEZ",
  "numeroCasasDecimais": 1,
  "digitacaoAvaliacaoParcial": "PADPRO",
  "listaConceitoNota": null,
  "listaTipoNota": [
    {
      "idTipoNota": 42,
      "sigla": "N1",
      "descricaoTipoNota": "1º Bimestre",
      "notaCalculada": 0,
      "notaExame": 0,
      "digitaFaltas": 1,
      "interdisciplinar": 0,
      "ordem": 1,
      "calculaFrequencia": 1,
      "reprovaFrequencia": 1,
      "notaMinimaAprovacao": null,
      "notaMinimaExame": null,
      "dataInicioAvaliacaoStr": "27/07/2016",
      "dataFimAvaliacaoStr": "28/09/2016"
    },
    {
      "idTipoNota": 40,
      "sigla": "N2",
      "descricaoTipoNota": "2º Bimestre",
      "notaCalculada": 0,
      "notaExame": 0,
      "digitaFaltas": 1,
      "interdisciplinar": 0,
      "ordem": 2,
      "calculaFrequencia": 1,
      "reprovaFrequencia": 1,
      "notaMinimaAprovacao": null,
      "notaMinimaExame": null,
      "dataInicioAvaliacaoStr": "29/09/2016",
      "dataFimAvaliacaoStr": "13/12/2016"
    },
    {
      "idTipoNota": 43,
      "sigla": "MS",
      "descricaoTipoNota": "Média Semestral",
      "notaCalculada": 1,
      "notaExame": 0,
      "digitaFaltas": 0,
      "interdisciplinar": 0,
      "ordem": 3,
      "calculaFrequencia": 1,
      "reprovaFrequencia": 1,
      "notaMinimaAprovacao": 7,
      "notaMinimaExame": 3,
      "dataInicioAvaliacaoStr": "",
      "dataFimAvaliacaoStr": ""
    },
    {
      "idTipoNota": 39,
      "sigla": "EX1",
      "descricaoTipoNota": "Exame 1",
      "notaCalculada": 0,
      "notaExame": 1,
      "digitaFaltas": 0,
      "interdisciplinar": 0,
      "ordem": 4,
      "calculaFrequencia": 1,
      "reprovaFrequencia": 1,
      "notaMinimaAprovacao": null,
      "notaMinimaExame": null,
      "dataInicioAvaliacaoStr": "",
      "dataFimAvaliacaoStr": ""
    },
    {
      "idTipoNota": 41,
      "sigla": "MF",
      "descricaoTipoNota": "Média Final",
      "notaCalculada": 1,
      "notaExame": 0,
      "digitaFaltas": 0,
      "interdisciplinar": 0,
      "ordem": 5,
      "calculaFrequencia": 1,
      "reprovaFrequencia": 1,
      "notaMinimaAprovacao": 5.35,
      "notaMinimaExame": null,
      "dataInicioAvaliacao": "",
      "dataFimAvaliacao": ""
    }
  ]
}

Quando o valor do atributo codigoRetornoIntegracao é diferente de ICA_00000, significa que ocorreu algum erro no WebService e não foi possível montar o retorno completo.
Para identificar melhor o erro, pode-se consultar o código retornado no atributo descrito acima na documentação, e ainda observar os atributos descricaoRetornoIntegracao e observacaoRetornoIntegracao que conterão maiores detalhes sobre o ocorrido.
Segue abaixo um exemplo de erro retornado:

{
  "codigoRetornoIntegracao": "ICA_00401",
  "descricaoRetornoIntegracao": "Turma/disciplina não encontrada",
  "observacaoRetornoIntegracao": "Não foi possível recuperar a turma/disciplina.",
  "idPacronizacaoDisciplina": null,
  "descricaoCriterioAvaliacao": null,
  "tipoDigitacaoNota": null,
  "numeroCasasDecimais": null,
  "digitacaoAvaliacaoParcial": null,
  "listaConceitoNota": null,
  "listaTipoNota": null
}