Serviço externo padrão - Realizar afastamento de matrícula
Este serviço registra o afastamento da matrícula do aluno.
1. Parâmetros para chamada do serviço externo
Parâmetro | Descrição | Obrigatório | Tipo | |
---|---|---|---|---|
ingressoID | ID do ingresso do aluno que será realizado o afastamento | Sim | Integer | |
requerimentoSolicitadoID | ID da solicitação de requerimento que originou o pedido de afastamento | Não | Integer | |
periodoLetivoID | ID do período letivo da matrícula que sofrerá afastamento | Sim | Integer | |
qtdPeriodosAfast | Quantidade de períodos de afastamento | Sim | Integer |
2. Exemplo de chamada do Serviço
URL: http://IP:PORTA/APLICACAO/rest/servicoexterno/execute/afastamentoMatricula
2.1. Exemplo da passagem de parâmetros por Json:
{ "ingressoID" : 123456, "requerimentoSolicitadoID" : 1234, "periodoLetivoID" : 12, "qtdPeriodosAfast" : 1 }
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.
3.1. Atributos retornados do serviço para o chamador
Campo | Descrição | Tipo | Observação |
---|---|---|---|
resultado | Retorna a situação do resultado | String(7) | Valores possíveis: SUCESSO / ERRO |
Exemplo de retorno Json:
{ "resultado": "SUCESSO" }
3.2. Possíveis retornos de erro para o chamador do serviço
Exemplo de retorno Json:
{ "resultado": "ERRO", "erro": { "operacao": "br.com.edusoft.mentorweb.servico.controller.ServicoExternoAcademicoImplJava.afastamentoMatricula", "valores": "{\r\n \"ingressoID\" : 0,\r\n \"requerimentoSolicitadoID\" : 0,\r\n \"periodoLetivoID\" : 0,\r\n \"qtdPeriodosAfast\" : 0\r\n}", "motivo": "Mensagem detalhada do problema" } }