Serviço externo padrão MentorWeb - Grava as notas dos alunos na avaliação parcial

Serviço externo do Mentor que realiza a gravação das notas dos alunos na avaliação parcial
Para saber mais sobre serviços externos clique aqui.

Nome do serviço externo: gravaNotaAvaliacaoParcialParaListaDeAlunos

Para ver 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

Identificação dos alunos e notas
Parâmetro	Descrição	Obrigatório	Tipo	Observação
Identificação da avaliação
idAvaliacao	ID da avaliação	Não	Numérico
codigoIntegracaoAvaliacao	Código de integração da avaliação	Não	Texto


listAlunoNota	Lista de alunos com suas respectivas notas	Sim	Lista
idAluno	ID do aluno	Não	Numérico
codigoIntegracaoAluno	Código de integração do aluno	Não	Texto
nota	Nota do aluno	Sim	Texto	Exemplo: “7.5”

1.1. Observações

Identificação da avaliação: Pelo menos um dos parâmetros para a identificação da avaliação deve ser informado.
Identificação dos alunos e notas (Lista): O parâmetro “nota” é obrigatório e pelo menos um dos parâmetros para a identificação do aluno deve ser informado.

Obs.: Se no parâmetro “nota” for passado um valor incorreto, o processo será interrompido e não irá realizar a gravação da nota de nenhum aluno informado.

2. Exemplo de chamada do Serviço pelo postman

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

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

{
    "idAvaliacao": 9875,
    "codigoIntegracaoAvaliacao":"",
    "listAlunoNota":[
        {
            "idAluno":null,
            "codigoIntegracaoAluno":"CODEADALUNO",
            "nota":"5.0"
        },
        {
            "idAluno":246531,
            "codigoIntegracaoAluno":"",
            "nota":"8.7"
        },
        {
            "idAluno":227353,
            "codigoIntegracaoAluno":"",
            "nota":"10.0"
        }
    ]
}

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.
Durante o processo, por inconsistência dos parâmetros ou devido a outras validações, podem haver cenários em que nem todos os alunos informados tenham a nota gravada.

Exemplos de retorno Json no caso de sucesso para a gravação da nota de todos os alunos:

Sucesso - Status code 200:

{
    "valor": {
        "idAvaliacao": 72713.0,
        "codigoIntegracaoAvaliacao": "",
        "listAlunoNota": [
            {
                "idAluno": 210881.0,
                "codigoIntegracaoAluno": "",
                "nota": "5.0",
                "notaNumerica": 5.0
            },
            {
                "idAluno": 246531.0,
                "codigoIntegracaoAluno": "",
                "nota": "8.7",
                "notaNumerica": 8.7
            },
            {
                "idAluno": 227353.0,
                "codigoIntegracaoAluno": "",
                "nota": "10.0",
                "notaNumerica": 10.0
            }
        ],
        "codigoRetornoIntegracao": "ICA_00000",
        "descricaoRetornoIntegracao": "Sucesso."
    },
    "resultado": "SUCESSO"
}

Exemplos de retorno Json no caso de sucesso para a gravação da nota de 2 alunos e erro para 1:

Sucesso - Status code 200:

{
    "valor": {
        "idAvaliacao": 72713.0,
        "codigoIntegracaoAvaliacao": "",
        "listAlunoNota": [
            {
                "codigoIntegracaoAluno": "CODEADALUNO",
                "nota": "5.0",
                "notaNumerica": 5.0,
                "codigoRetornoIntegracao": "ICA_00800",
                "descricaoRetornoIntegracao": "Ocorreu uma inconsistência, porém não necessitou interromper o processo.",
                "observacaoRetornoIntegracao": "A nota deste aluno não foi integrada pois não foi encontrado o vínculo deste aluno com a             avaliação informada no MentorWeb."
            },
            {
                "idAluno": 246531.0,
                "codigoIntegracaoAluno": "",
                "nota": "8.7",
                "notaNumerica": 8.7
            },
            {
                "idAluno": 227353.0,
                "codigoIntegracaoAluno": "",
                "nota": "10.0",
                "notaNumerica": 10.0
            }
        ],
        "codigoRetornoIntegracao": "ICA_00800",
        "descricaoRetornoIntegracao": "Ocorreu uma inconsistência no detalhe de alunos, porém não necessitou interromper o processo e as              notas foram gravadas. Por favor, verifique os detalhes para analisar a inconsistência ocorrida."
    },
    "resultado": "SUCESSO"
}

Com erro - Status code 509:

{
    "resultado": "ERRO",
    "erro": {
        "operacao": "br.com.edusoft.mentorweb.servico.controller.ServicoExternoAcademicoImplJava.gravaNotaAvaliacaoParcialParaListaDeAlunos",
        "valores": "{\r\n    \"idAvaliacao\": 9875,\r\n    \"codigoIntegracaoAvaliacao\":\"\",\r\n    \"listAlunoNota\":[\r\n        {\r\n            \"idAluno\":null,\r\n            \"codigoIntegracaoAluno\":\"CODEADALUNO\",\r\n            \"nota\":\"5.0\"\r\n        },\r\n        {\r\n            \"idAluno\":246531,\r\n            \"codigoIntegracaoAluno\":\"\",\r\n            \"nota\":\"8.7\"\r\n        },\r\n        {\r\n            \"idAluno\":227353,\r\n            \"codigoIntegracaoAluno\":\"\",\r\n            \"nota\":\"10.0\"\r\n        }\r\n    ]\r\n}",
        "motivo": "EduClientLogProcessoException: Disciplina sem avaliações agendadas ou fórmula de cálculo definida. Realize o agendamento e/ou definição da fórmula a partir do link \"Cadastro de provas e trabalhos\"."
    }
}