Exclusão de avaliação parcial

Este tópico lista as características do WebService de exclusão de avaliação parcial.
Este método deverá ser chamado para realizar a exclusão de avaliações parciais. A avaliação só poderá ser excluída caso não hajam notas digitadas.

Nome do método: excluiAvaliacaoParcial(…)

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.
idAvaliacao Identificador da avaliação Não * Inteiro Informar o identificador da avaliação que será excluída.
codigoIntegracaoAvaliacao Código de integração da avaliação Não * String Informar o código de integração da avaliação (caso o MentorWeb tenha conhecimento deste código)
* 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.


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_00406 Avaliação não encontrada Ocorre quando não encontrou uma avaliação com o identificador informado.
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_00424 Avaliação encontrada não está integrada com EAD Ocorre quando a avaliação encontrada pelo identificador informado não está integrada com o EAD.

Exemplo de chamada do WebService

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

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,
    "idAvaliacao":486,
    "codigoIntegracaoAvaliacao":"200"
}

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/excluiAvaliacaoParcial",
    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,"idAvaliacao":486,"codigoIntegracaoAvaliacao":"200"}',
    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":null
}

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_00406",
  "descricaoRetornoIntegracao": "Nenhuma avaliação encontrada.",
  "observacaoRetornoIntegracao": "Nenhuma avaliação encontrada.",
  "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. :-)

Voltar