Cadastro de avaliação parcial
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 |
---|---|---|---|---|
ctx | Contexto | Sim | String[] | Informar a “unidade”, “modulo”, e “usuario” do MentorWeb |
idTurmaDisciplina | Identificador da turma/disciplina | Não * | Inteiro | Informar o identificador da turma/disciplina no MentorWeb |
codigoIntegracaoTurmaDisciplina | 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. |
* 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. |
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 |
---|---|---|
000 | Sucesso | Obteve sucesso na chamada e retorno do WebService. |
400 | 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. |
401 | Já existe uma avaliação com a sigla informada | Ocorre quando já existe uma avaliação com a sigla informada para o tipo de nota em questão. |
402 | Diário fechado | Ocorre quando o diário está fechado. |
403 | Fora do prazo de digitação | Ocorre quando o período de digitação não está vigente. |
404 | Ocorreu um erro ao tentar cadastrar a avaliação | Ocorre quando aconteceu um erro inesperado ao cadastrar a avaliação. Verificar a descrição do erro neste caso. |
405 | Avaliação não encontrada. | Ocorre quando foi informada a avaliação para realizar alteração, porém, essa avaliação não foi encontrada no MentorWeb. |