Serviço externo padrão - Cancelamento de disciplina

Este serviço realiza o cancelamento de uma ou mais disciplinas da matrícula do aluno.

1. Parâmetros para chamada do serviço externo

Parâmetro Descrição Obrigatório Tipo Observação
listMestreDiscipId Lista de ids do mestre disciplina para serem canceladas Sim List / Integer ZZ
dataCancelamento Data de cancelamento Sim Date Formado: dd/mm/yyyy
motivoId Id do motivo de cancelamento Não Integer
situacaoResultadoId Id da situação de resultado que a disciplina cancelada assume Não Integer Caso o parâmetro não seja passado, o sistema assume o resultado de maior ordem do tipo “Não concluiu”
observacoes Observações sobre o cancelamento Não String
unidadeId Código da unidade Sim Integer

2. Exemplo de chamada do Serviço

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


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

{
  "listMestreDiscipId" : [{"mestreDisciplinaId" : 608008}],
  "dataCancelamento" : "26/02/2017 00:00:00",
  "montivoId" : null,
  "situacaoResultadoId" : null,
  "observacoes" : "Teste",
  "unidadeId" : 4
}

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.

Exemplo de retorno Json:

Sucesso - Status code 200:

{
    "valor": "Disciplina cancelada com sucesso.",
    "resultado": "SUCESSO"
}

Erro - Status code 500:

{
    "resultado": "ERRO",
    "erro": {
        "operacao": "br.com.edusoft.mentorweb.servico.controller.ServicoExternoAcademicoImplJava.realizaCancelamentoDeDisciplina",
        "valores": "{\n  \"listMestreDiscipId\" : [{\"mestreDisciplinaId\" : 608008}],\n  \"dataCancelamento\" : \"26/02/2017 00:00:00\",\n  \"montivoId\" : null,\n  \"situacaoResultadoId\" : null,\n  \"observacoes\" : \"Teste\",\n  \"unidadeId\" : 4\n}",
        "motivo": "EduClientLogProcessoException: Disciplina não está ativa."
    }
}
  • (edição externa)