1. API de Integração
  2. Métodos para integração com o OPA (aplicativo mobile)
OPA - Consultar Disciplinas

Lista todas as disciplinas uma determinada matriz.
Método: POST
Resposta: JSON/XML

Parâmetro Obrigatório Tipo Descrição
format Sim java.lang.String Formato do retorno (JSON/XML)
idCurso Sim java.lang.Integer Código da Matriz Curricular (Curso)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/opa/matriz/disciplinas

Formato do objeto de retorno

{
  "idDisciplina (Integer)": null,
  "idPeriodo (Integer)": null,
  "descricao (String)": null,
  "cargaHoraria (Integer)": null,
  "complementariadade (String)": null,
  "periodo (String)": null,
  "periodoORdem (Integer)": null
}
OPA - Consultar Grade de Aulas

Lista as Disciplinas Horário Sala de uma Matricula, Professor ou de uma Turma.
Método: POST
Resposta: JSON/XML

Parâmetro Obrigatório Tipo Descrição
format Sim java.lang.String Formato do retorno (JSON/XML)
idProfessor Não java.lang.Integer Código da Matriz Curricular (Curso)
idMatricula Não java.lang.Integer Código Matricula
idTurma Não java.lang.Integer Código Turma
idDisciplina Não java.lang.Integer Código Disciplina

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/opa/grade/aulas

Formato do objeto de retorno

{
  "idDisciplinaHorarioSala (Integer)": null,
  "idSala (Integer)": null,
  "sala (String)": null,
  "bloco (String)": null,
  "turma (String)": null,
  "disciplina (String)": null,
  "idDisciplinaProfessor (Integer)": null,
  "idProfessor (Integer)": null,
  "nomeProfessor (String)": null,
  "horaInicio (Time)": null,
  "horaTermino (Time)": null,
  "status (String)": null,
  "dataFixa (Date)": null,
  "periodoLetivo (String)": null,
  "situacaoPeriodoLetivo (String)": null,
  "nomeCursoBase (String)": null,
  "idTurma (Integer)": null,
  "turno (String)": null,
  "periodoDisciplina (String)": null,
  "cargaHoraria (Integer)": null,
  "idOrg (Integer)": null
}
OPA - Lancar Falta do aluno

Será registrado uma falta no horário informado, para a Matricula Disciplina Informada.
Método: POST
Resposta: Retornará o status 200 OK caso tenha ocorrido todo o processamento de forma correta

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
idDisciplinaHorarioSala Sim java.lang.Integer Código Disciplina Horario
idMatriculaDisciplina Sim java.lang.Integer Código Matricula Disciplina

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/opa/lancar/falta
OPA - Lançar Falta dos alunos (Lote)

Será registrado uma falta no horário informado, para as Matriculas Disciplina Informadas.
Método: POST
Resposta: Retornará o status 200 OK caso tenha ocorrido todo o processamento de forma correta

Parâmetro Obrigatório Tipo Descrição
idDisciplinaHorarioSala Sim java.lang.Integer Código Disciplina Horario
idsMatriculaDisciplina Sim java.util.List Código Matricula Disciplina

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/opa/lancar/falta/lote
OPA - Calendário de provas

Lista todas as avaliações de uma disciplina professor.
Método: POST
Resposta: JSON/XML

Parâmetro Obrigatório Tipo Descrição
format Sim java.lang.String Formato do retorno (JSON/XML)
idDisciplinaProfessor Não java.lang.Integer Código da Matriz Curricular (Curso)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/opa/calendario/provas

Formato do objeto de retorno

{
  "idTurma (Integer)": null,
  "idProfessor (Integer)": null,
  "idDisciplina (Integer)": null,
  "idDisciplinaProfessor (Integer)": null,
  "subPeriodo (String)": null,
  "avaliacaoDescricao (String)": null,
  "dataAvaliacao (Date)": null,
  "identificacao (String)": null,
  "avaliacao (String)": null,
  "disciplina (String)": null,
  "professor (String)": null,
  "turma (String)": null,
  "curso (String)": null,
  "preiodoLetivo (String)": null,
  "id_org (Integer)": null
}
OPA - Consulta de notas de uma matricula

Lista todas as disciplinas ativas (disciplina, professor, nota, status, etc.) de uma determinada matricula
Método: POST
Resposta: JSON/XML

Parâmetro Obrigatório Tipo Descrição
idMatricula Sim java.lang.Integer ID Matricula
format Sim java.lang.String Formato do retorno (JSON/XML)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/opa/notas

Formato do objeto de retorno

{
  "idMatricula (Integer)": null,
  "idMatriculaDisciplina (Integer)": null,
  "idDisciplinaProfessor (Integer)": null,
  "idTurma (Integer)": null,
  "idAluno (Integer)": null,
  "disciplina (String)": null,
  "periodo (String)": null,
  "turma (String)": null,
  "periodoLetivo (String)": null,
  "professor (String)": null,
  "notaFinal (Double)": null,
  "notaExame (Double)": null,
  "frequencia (Double)": null,
  "quantidadeAulas (Integer)": null,
  "status (String)": null,
  "statusLegivel (String)": null,
  "statusCor (String)": null
}
OPA - Lista de Avaliações da disciplina do aluno

Lista todas as avaliações de uma disciplina do aluno
Método: POST
Resposta: JSON/XML

Parâmetro Obrigatório Tipo Descrição
idAluno Sim java.lang.Integer ID Aluno
idMatriculaDisciplina Sim java.lang.Integer ID da Matrícula Disciplina
format Sim java.lang.String Formato do retorno (JSON/XML)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/opa/notas/avaliacoes

Formato do objeto de retorno

{
  "idMatriculaDisciplina (Integer)": null,
  "frequencia (Double)": null,
  "avaliacao (String)": null,
  "identificacao (String)": null,
  "nota_para_apresentar (String)": null,
  "notaFinal (Double)": null,
  "statusDescricao (String)": null,
  "statusLegivel (String)": null,
  "quantFaltas (Integer)": null,
  "disciplina (String)": null,
  "dataAvaliacao (Date)": null,
  "dataVisualizacaoNota (Date)": null,
  "unixDataAvaliacao (Long)": null,
  "unixDataVisualizacaoNota (Long)": null,
  "id_org (Integer)": null
}
OPA - Consultar Disciplinas das Turmas

Lista todas as disciplinas ministradas pelos professores de períodos letivos ativos da instituição combinada com diversos filtros.
Método: POST
Resposta: JSON/XML

Parâmetro Obrigatório Tipo Descrição
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Não java.lang.Integer Código da instituição
idTurma Não java.lang.Integer Código da Turma
idPeriodoLetivo Não java.lang.Integer Código do Período Letivo
idCurso Não java.lang.Integer Código da Matriz Curricular (Curso)
idProfessor Não java.lang.Integer Código do professor

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/opa/turmas/disciplinas

Formato do objeto de retorno

{
  "idDisciplinaProfessor (Integer)": null,
  "idProfessor (Integer)": null,
  "idTurma (Integer)": null,
  "valorNormal (Double)": null,
  "quantVagas (Integer)": null,
  "curso (String)": null,
  "cursoBase (String)": null,
  "professor (String)": null,
  "disciplina (String)": null,
  "turma (String)": null,
  "descPeriodo (String)": null,
  "periodoLetivo (String)": null,
  "cargaHorario (Integer)": null,
  "idProfessorCoordenador (Integer)": null,
  "quantAlunosMatriculados (Integer)": null,
  "idCourseMoodle (Integer)": null,
  "quantAulas (Integer)": null,
  "idPeriodoLetivo (Integer)": null,
  "idOrgTurma (Integer)": null
}
OPA - Login - Autenticação de Professores

Efetua a autenticação de um Professor através de login e senha informados.
Método: POST
Resposta: JSON/XML

Parâmetro Obrigatório Tipo Descrição
login Sim java.lang.String Login
password Sim java.lang.String Senha
format Sim java.lang.String Formato do retorno (JSON/XML)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/opa/login/professor

Formato do objeto de retorno

{
  "idProfessor (Integer)": null,
  "idFuncionario (Integer)": null,
  "idPerfil (Integer)": null,
  "titulacao (String)": null,
  "escolaridade (String)": null,
  "nome (String)": null,
  "cpf (String)": null,
  "rg (String)": null,
  "dataNascimento (Date)": null,
  "sexo (String)": null,
  "email (String)": null,
  "cidade (String)": null,
  "celular (String)": null,
  "fone (String)": null
}
OPA - Login - Autenticação de Alunos

Efetua a autenticação de um aluno através de login e senha informados.
Método: POST
Resposta: JSON/XML

Parâmetro Obrigatório Tipo Descrição
login Sim java.lang.String Login
password Sim java.lang.String Senha
format Sim java.lang.String Formato do retorno (JSON/XML)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/opa/login/aluno

Formato do objeto de retorno

{
  "idAluno (Integer)": null,
  "idPerfil (Integer)": null,
  "ra (String)": null,
  "nome (String)": null,
  "cpf (String)": null,
  "rg (String)": null,
  "rgOrgaoExpedidor (String)": null,
  "rgDataEmissao (Date)": null,
  "rne (String)": null,
  "pai (String)": null,
  "mae (String)": null,
  "dataNascimento (Date)": null,
  "estadoCivil (String)": null,
  "sexo (String)": null,
  "email (String)": null,
  "nacionalidade (String)": null,
  "religiao (String)": null,
  "logradouro (String)": null,
  "cep (String)": null,
  "bairro (String)": null,
  "complemento (String)": null,
  "cidade (String)": null,
  "estado (String)": null,
  "uf (String)": null,
  "celular (String)": null,
  "fone (String)": null,
  "idOrg (Integer)": null
}
OPA - Login - Autenticação de Usuário

Efetua a autenticação de um Professor através de login e senha informados.
Método: POST
Resposta: JSON/XML

Parâmetro Obrigatório Tipo Descrição
login Sim java.lang.String Login
password Sim java.lang.String Senha
format Sim java.lang.String Formato do retorno (JSON/XML)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/opa/login/usuario

Formato do objeto de retorno

{
  "idUsuario (Integer)": null,
  "idGrupoUsuario (Integer)": null,
  "nome (String)": null,
  "status (String)": null,
  "idFuncionario (Integer)": null,
  "nomePerfil (String)": null
}
OPA - Alteração da senha de acesso

Altera a senha de alunos ou professores.
Método: POST
Resposta: Retornará o status 200 OK caso tenha ocorrido todo o processamento de forma correta

Parâmetro Obrigatório Tipo Descrição
idPerfil Sim java.lang.Integer ID Perfil
senhaAtual Sim java.lang.String Senha Atual
senhaNova Sim java.lang.String Senha Nova
senhaConfirmacao Sim java.lang.String Senha Nova Confirmação
format Sim java.lang.String Formato do retorno (JSON/XML)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/opa/senha/alterar
OPA - Recuperar senha de acesso

Envia e-mail de recuperação de senha para o perfil.
Método: POST
Resposta: Retornará o status 200 OK caso tenha ocorrido todo o processamento de forma correta

Parâmetro Obrigatório Tipo Descrição
cpf Sim java.lang.String CPF
email Sim java.lang.String E-Mail
format Sim java.lang.String Formato do retorno (JSON/XML)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/opa/senha/recuperar