1. API de Integração
  2. Métodos para integração com o OPA (aplicativo mobile)
  • OPA - Alteração da senha de acesso
  • OPA - Calendário de provas
  • OPA - Consulta de notas de uma matricula
  • OPA - Consultar Disciplinas
  • OPA - Consultar Disciplinas das Turmas
  • OPA - Consultar Grade de Aulas
  • OPA - Consultar faltas
  • OPA - Lancar Falta do aluno
  • OPA - Lançar Falta dos alunos (Lote)
  • OPA - Lista de Avaliações da disciplina do aluno
  • OPA - Login - Autenticação de Alunos
  • OPA - Login - Autenticação de Professores
  • OPA - Login - Autenticação de Usuário
  • OPA - Recuperar senha de acesso
  • OPA - Remover faltas
  • Detalhes
  • Parâmetros
  • Descrição:
  • Altera a senha de alunos ou professores.
  • Verbo:
  • POST
  • Resposta:
  • Retornará o status 200 OK caso tenha ocorrido todo o processamento de forma correta
  • URIs de Acesso:
  • https://famerco.jacad.com.br:443/academico/api/v1/opa/senha/alterar
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)
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Lista todas as avaliações de uma disciplina professor.
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://famerco.jacad.com.br:443/academico/api/v1/opa/calendario/provas
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)
{
  "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,
  "id_usuario_criacao (Integer)": null,
  "id_usuario_alteracao (Integer)": null,
  "data_criacao (Timestamp)": null,
  "data_alteracao (Timestamp)": null,
  "buscaIndexada (boolean)": false,
  "isIgnorarLog (boolean)": false
}
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Lista todas as disciplinas ativas (disciplina, professor, nota, status, etc.) de uma determinada matricula
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://famerco.jacad.com.br:443/academico/api/v1/opa/notas
Parâmetro Obrigatório Tipo Descrição
idMatricula Sim java.lang.Integer ID Matricula
format Sim java.lang.String Formato do retorno (JSON/XML)
{
  "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
}
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Lista todas as disciplinas uma determinada matriz.
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://famerco.jacad.com.br:443/academico/api/v1/opa/matriz/disciplinas
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)
{
  "idDisciplina (Integer)": null,
  "idPeriodo (Integer)": null,
  "descricao (String)": null,
  "cargaHoraria (Integer)": null,
  "complementariadade (String)": null,
  "periodo (String)": null,
  "periodoORdem (Integer)": null
}
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Lista todas as disciplinas ministradas pelos professores de períodos letivos ativos da instituição combinada com diversos filtros.
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://famerco.jacad.com.br:443/academico/api/v1/opa/turmas/disciplinas
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 Disciplina Professor
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
{
  "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,
  "professoresAuxiliares (ArrayList)": []
}
{ "idProfessor (Integer)": null, "idDisciplinaProfessor (Integer)": null, "registrarFrequencia (Integer)": null, "registrarConteudoMinistrado (Integer)": null, "lancarNota (Integer)": null, "lancarNotaSubAvaliacao (Integer)": null, "enviarAviso (Integer)": null, "parecerDescritivo (Integer)": null, "anexarArquivo (Integer)": null, "avaliarLoteCorrecao (Integer)": null, "calendarioRotativo (Integer)": null }
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Lista as Disciplinas Horário Sala de uma Matricula, Professor ou de uma Turma.
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://famerco.jacad.com.br:443/academico/api/v1/opa/grade/aulas
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 do Professor
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
{
  "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
}
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Retorna a lista de matrículas disciplina que tiveram falta lançada no horário informado
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://famerco.jacad.com.br:443/academico/api/v1/opa/faltas
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
idDisciplinaProfessor Sim java.lang.Integer Código Disiplina Professor
idMatriculaDisciplina Não java.lang.Integer Código Matricula Disciplina
format Sim java.lang.String Formato do retorno (JSON/XML)
{
  "idFrequenciaFalta (Integer)": null,
  "idMatriculaDisciplina (Integer)": null,
  "idDisciplinaHorarioSala (Integer)": null,
  "idPeriodoLetivo (Integer)": null,
  "idSubPeriodoLetivo (Integer)": null,
  "idDisciplinaProfessor (Integer)": null,
  "idProfessor (Integer)": null,
  "data (Date)": null
}
  • Detalhes
  • Parâmetros
  • Descrição:
  • Será registrado uma falta no horário informado, para a Matricula Disciplina Informada.
  • Verbo:
  • POST
  • Resposta:
  • Retornará o status 200 OK caso tenha ocorrido todo o processamento de forma correta
  • URIs de Acesso:
  • https://famerco.jacad.com.br:443/academico/api/v1/opa/lancar/falta
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
  • Detalhes
  • Parâmetros
  • Descrição:
  • Será registrado uma falta no horário informado, para as Matriculas Disciplina Informadas.
  • Verbo:
  • POST
  • Resposta:
  • Retornará o status 200 OK caso tenha ocorrido todo o processamento de forma correta
  • URIs de Acesso:
  • https://famerco.jacad.com.br:443/academico/api/v1/opa/lancar/falta/lote
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
idsMatriculaDisciplina Sim java.util.List Código Matricula Disciplina
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Lista todas as avaliações de uma disciplina do aluno
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://famerco.jacad.com.br:443/academico/api/v1/opa/notas/avaliacoes
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)
{
  "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,
  "id_usuario_criacao (Integer)": null,
  "id_usuario_alteracao (Integer)": null,
  "data_criacao (Timestamp)": null,
  "data_alteracao (Timestamp)": null,
  "buscaIndexada (boolean)": false,
  "isIgnorarLog (boolean)": false
}
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Efetua a autenticação de um aluno através de login e senha informados.
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://famerco.jacad.com.br:443/academico/api/v1/opa/login/aluno
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)
{
  "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,
  "orgDescricao (String)": null
}
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Efetua a autenticação de um Professor através de login e senha informados.
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://famerco.jacad.com.br:443/academico/api/v1/opa/login/professor
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)
{
  "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
}
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Efetua a autenticação de um usuário através de login e senha informados.
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://famerco.jacad.com.br:443/academico/api/v1/opa/login/usuario
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)
{
  "idUsuario (Integer)": null,
  "idGrupoUsuario (Integer)": null,
  "nome (String)": null,
  "status (String)": null,
  "idFuncionario (Integer)": null,
  "nomePerfil (String)": null
}
  • Detalhes
  • Parâmetros
  • Descrição:
  • Envia e-mail de recuperação de senha para o perfil.
  • Verbo:
  • POST
  • Resposta:
  • Retornará o status 200 OK caso tenha ocorrido todo o processamento de forma correta
  • URIs de Acesso:
  • https://famerco.jacad.com.br:443/academico/api/v1/opa/senha/recuperar
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)
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Remove a falta do aluno no horário informado
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://famerco.jacad.com.br:443/academico/api/v1/opa/remover-falta
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
idDisciplinaProfessor Sim java.lang.Integer Código Disiplina Professor
idMatriculaDisciplina Sim java.lang.Integer Código Matricula Disciplina
{
  "idFrequenciaFalta (Integer)": null,
  "idMatriculaDisciplina (Integer)": null,
  "idDisciplinaHorarioSala (Integer)": null,
  "idPeriodoLetivo (Integer)": null,
  "idSubPeriodoLetivo (Integer)": null,
  "idDisciplinaProfessor (Integer)": null,
  "idProfessor (Integer)": null,
  "data (Date)": null
}