Este tópico lista as características do WebService Json de cadastro de avaliação parcial.
Este método deverá ser chamado para realizar o cadastro de avaliações parciais em um determinado tipo de nota da turma/disciplina.
Nome do método: cadastraAvaliacaoParcial(…)
Parâmetros para chamada do WebService
Parâmetro | Descrição | Obrigatório | Tipo | Observação |
---|---|---|---|---|
codigoUnidade | Código da unidade | Sim | Inteiro | Informar o código de unidade do MentorWeb. |
idTurmaDisciplina | Identificador da turma/disciplina | Não * | Inteiro | Informar o identificador da turma/disciplina no MentorWeb |
codigoIntegracaoTdi | 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 | Inteiro | Identificador do tipo de nota para qual será criada a avaliação (verificar método recuperaTipoNotaPorTurmaDisciplina) |
idAvaliacao | Identificador da avaliação | Não | Inteiro | Identificador da avaliação. Quando informado, será realizada uma alteração (update) na avaliação. |
codigoIntegracaoAvaliacao | Código de integração da avaliação | Sim | String | Código único da avaliação parcial. Quando informado, será realizada uma alteração (update) na avaliação. |
descricao | Descrição da avaliação | Sim | String (60) | Informar a descrição da avaliação (Ex.: Avaliação 01) |
sigla | Sigla da avaliação | Sim | String (10) | Informar a sigla da avaliação (Ex.: AVA01) - Não utilizar códigos especiais e separadores. |
conteudo | Conteúdo da avaliação | Sim | String (4000) | Informar o conteúdo da avaliação, ou seja, o que cairá na prova/trabalho. |
obrigatorioParaCalculo | Obrigatório para o cálculo da média | Não | Inteiro | Informar se a avaliação é obrigatória para o cálculo da média. Valores possíveis: 0 ⇒ Não (default) 1 ⇒ Sim |
data | Data da avaliação | Não | String | Data para agendamento da avaliação. Se não for informada será considerada a data atual. Em ambos os casos será feita uma verificação se há cronograma naquele dia, se não houver, será considera a data mais próxima de cronograma em relação a data informada ou data atual se não for informada. (Formato: dd/MM/yyyy) |
* 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 | String | 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 referente a integração | String | Poderá conter os detalhe do retorno da integração, geralmente quando ocorre um erro. |
idAvaliacao | Identificador da avaliação cadastrada | Integer | Identificador da avaliação cadastrada no MentorWeb. |
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 | Turma/disciplina não encontrada | Ocorre quando a turma disciplina informada não existe no Mentor Web. |
ICA_00403 | Tipo de nota não encontrado | Ocorre quando o tipo de nota informado não existe no Mentor Web. |
ICA_00408 | Tipo de digitação de notas inválido | Ocorre quando o tipo de nota não está configurado para o professor definir as avaliações. |
ICA_00411 | Diário fechado. | Ocorre quando o diário está encerrado para essa turma e avaliação. |
ICA_00414 | Ocorreu um erro ao realizar o processo | Ocorre quando há algum erro sem relação direta com a integração ou erros não previstos (erros de banco de dados por exemplo), na descrição trará uma mensagem genérica e na observação o erro detalhado. |
ICA_00416 | Não há período de diário definido | Ocorre quando os períodos de diário não estão configurados para a turma/disciplina no Mentor Web. |
ICA_00417 | Fora do período de avaliação | Ocorre quando a avaliação está fora do período de digitação. |
ICA_00418 | Fora do período de avaliação | Ocorre quando a avaliação está fora do período de digitação. |
ICA_00420 | Parâmetro de data inválido | Ocorre quando a data informada para a prova está em formato inválido. |
ICA_00423 | Não há cronograma gerado para a data informada | Ocorre quando não há cronograma de aula gerado para a turma/disciplina na data informada ou nas datas de hoje, anterior ou posterior à data de hoje, quando a data não for informada. |
Exemplo de chamada do WebService
URL: http://IP:PORTA/APLICACAO/rest/ICorujaACA/cadastraAvaliacaoParcial
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, "codigoIntegracaoTdi":"250", "idTipoNota":42, "idAvaliacao":null, "codigoIntegracaoAvaliacao":1, "descricao":"Prova de Álgebra", "sigla":"PA1", "conteudo":"Álgebra Básica", "obrigatorioParaCalculo":1, "data":"08/07/2017" }
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/cadastraAvaliacaoParcial", 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,"codigoIntegracaoTurmaDisciplina":"250","idTipoNota":42,"idAvaliacao":null, "codigoIntegracaoAvaliacao":1,"descricao":"Prova de Álgebra","sigla":"PA1","conteudo":"Álgebra Básica","obrigatorioParaCalculo":1,"data":"08/07/2017"}', 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, "idAvaliacao":3450 }
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_00400", "descricaoRetornoIntegracao": "Parâmetros inválidos", "observacaoRetornoIntegracao": "É obrigatório informar o código de integração da avaliação.", "idAvaliacao":null }
Ainda há dúvidas? Se você preferir retire suas dúvidas com o nosso suporte, clique aqui e abra um chamado para atendimento.