1. API de Integração
  2. Métodos para integração com LMS
  • Alunos
  • Atualizar nota do aluno
  • Atualizar nota do aluno (Lote)
  • Consulta alunos sem nota
  • Cursos Ofertados
  • Inscrições por Curso
  • Períodos Letivos habilitados
  • Professores
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Retorna uma lista de alunos de um período letivo liberado.
    Caso a chamada contenha mais de 300 objetos em seu retorno, será retornado os 300 objetos mais o campo nextPage com o link para os próximos 300 objetos.
    O token deve ser inserido no hearder usando o Authorization
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/ead/api/public/v1/alunos
Parâmetro Obrigatório Tipo Descrição
idPeriodoLetivo Sim java.lang.Integer Código Período Letivo.
idDisciplina Não java.lang.Integer Código Disciplina
idCurso Não java.lang.Integer Código Curso
idDisciplinaProfessor Não java.lang.Integer Código Disciplina Professor
idAluno Não java.lang.Integer Código Aluno
ra Não java.lang.String RA
format Não java.lang.String Formato do retorno (JSON/XML) default JSON
offset Não java.lang.Integer offset (número de registros a serem pulados na realização da consulta)
{
  "nextPage (String)": null,
  "result (ArrayList)": 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
  • Descrição:
  • Atualiza a nota de um aluno em uma avaliação especifica.
    O token deve ser inserido no hearder usando o Authorization
  • Verbo:
  • POST
  • Resposta:
  • Retornará o status 200 OK caso tenha ocorrido todo o processamento de forma correta
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/ead/api/public/v1/curso/inscricao/nota/lancar
Parâmetro Obrigatório Tipo Descrição
idDisciplinaProfessor Sim java.lang.Integer Código Disciplina Professor
idMatriculaDisciplina Sim java.lang.Integer Código Matrícula Disciplina (Inscrição do Aluno)
identificadorAvaliacao Sim java.lang.String Identificador da Avaliação
nota Sim java.lang.Double Nota do Aluno na Avaliação
format Não java.lang.String Formato do retorno (JSON/XML) default JSON
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Entrada
  • Formato do Objeto de Retorno
  • Descrição:
  • Atualiza em lote a nota de varios alunos, através de um array de objetos em formato json. Todos os parametros são obrigatórios.

    Para este método, além do token, é necessário informar também no HEADER do request o Content-Type com valor application/json

    Atenção: São aceitos no máximo 50 objetos por chamada
    O token deve ser inserido no hearder usando o Authorization
  • Verbo:
  • POST
  • Resposta:
  • Retornará o status 200 OK caso tenha ocorrido todo o processamento de forma correta ou um json com os objetos que apresentaram erros com o field 'erro' populado.
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/ead/api/public/v1/curso/inscricao/nota/lote/lancar
Parâmetro Obrigatório Tipo Descrição
matriculas Sim java.util.List Lista de Objetos
{
  "idDisciplinaProfessor (Integer)": null,
  "idMatriculaDisciplina (Integer)": null,
  "identificadorAvaliacao (String)": null,
  "nota (Double)": null,
  "erro (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
}
{
  "idDisciplinaProfessor (Integer)": null,
  "idMatriculaDisciplina (Integer)": null,
  "identificadorAvaliacao (String)": null,
  "nota (Double)": null,
  "erro (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
  • Descrição:
  • Consulta os alunos que não possuem nota em uma avaliação especifica.
    O token deve ser inserido no hearder usando o Authorization
  • Verbo:
  • POST
  • Resposta:
  • Retornará o status 200 OK caso tenha ocorrido todo o processamento de forma correta
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/ead/api/public/v1/alunos/sem/nota
Parâmetro Obrigatório Tipo Descrição
idDisciplinaProfessor Não java.lang.Integer Código Disciplina Professor
idTurma Não java.lang.Integer Código Turma
identificadorAvaliacao Sim java.lang.String Identificador da Avaliação
format Não java.lang.String Formato do retorno (JSON/XML) default JSON
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Retorna uma lista com os cursos ofertados em um período letivo liberado.
    Caso a chamada contenha mais de 300 objetos em seu retorno, será retornado os 300 objetos mais o campo nextPage com o link para os próximos 300 objetos.
    O token deve ser inserido no hearder usando o Authorization
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/ead/api/public/v1/cursos
Parâmetro Obrigatório Tipo Descrição
idPeriodoLetivo Sim java.lang.Integer Código Período Letivo.
idDisciplinaProfessor Não java.lang.Integer Código da Disciplina Professor (Curso)
idTurma Não java.lang.Integer Código da Turma
descricaoDisciplina Não java.lang.String Descrição da Disciplina
nomeReduzidoDisciplina Não java.lang.String Nome Reduzido da Disciplina
format Não java.lang.String Formato do retorno (JSON/XML) default JSON
offset Não java.lang.Integer offset (número de registros a serem pulados na realização da consulta)
{
  "nextPage (String)": null,
  "result (ArrayList)": 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:
  • Retorna uma lista contendo as inscrições de um determinado curso, contendo inscrições de ALUNO, PROFESSOR e PROFESSOR AUXILIAR
    O token deve ser inserido no hearder usando o Authorization
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/ead/api/public/v1/curso/inscricoes
Parâmetro Obrigatório Tipo Descrição
idDisciplinaProfessor Sim java.lang.Integer Código Disciplina Professor
roles Não [Ljava.lang.String; Array de String contendo o filtro de Papeis ['ALUNO','PROFESSOR','PROFESSOR_AUXILIAR']
idProfessor Não java.lang.Integer Código Professor
idMatriculaDisciplina Não java.lang.Integer Código Matrícula Disciplina (Inscrição do Aluno)
idAluno Não java.lang.Integer Código Aluno
format Não java.lang.String Formato do retorno (JSON/XML) default JSON
{
  "idMatriculaDisciplina (Integer)": null,
  "idAluno (Integer)": null,
  "ra (String)": null,
  "idDisciplinaProfessor (Integer)": null,
  "idDisciplinaProfessorAuxiliar (Integer)": null,
  "idProfessor (Integer)": null,
  "idCurso (Integer)": null,
  "idDisciplina (Integer)": null,
  "idPeriodoLetivo (Integer)": null,
  "role (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:
  • Retorna uma lista com os períodos letivos habilitados para integração.
    O token deve ser inserido no hearder usando o Authorization
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/ead/api/public/v1/periodos
Parâmetro Obrigatório Tipo Descrição
idPeriodoLetivo Não java.lang.Integer Código Período Letivo.
idOrg Não java.lang.Integer Código da Organização
format Não java.lang.String Formato do retorno (JSON/XML) default JSON
{
  "idPeriodoLetivo (Integer)": null,
  "descricao (String)": null,
  "descricaoEspecial (String)": null,
  "dataInicio (Date)": null,
  "dataTermino (Date)": null,
  "situacao (String)": null,
  "idOrg (Integer)": null,
  "isPeriodoAtual (Integer)": null,
  "ano (Integer)": null,
  "idProximoPeriodoLetivo (Integer)": 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:
  • Retorna uma lista de professores responsaveis e professores auxiliares de um período letivo liberado.
    Caso a chamada contenha mais de 300 objetos em seu retorno, será retornado os 300 objetos mais o campo nextPage com o link para os próximos 300 objetos.
    O token deve ser inserido no hearder usando o Authorization
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/ead/api/public/v1/professores
Parâmetro Obrigatório Tipo Descrição
idPeriodoLetivo Sim java.lang.Integer Código Período Letivo.
idDisciplinaProfessor Não java.lang.Integer Código Disciplina Professor
idDisciplina Não java.lang.Integer Código Disciplina
idCurso Não java.lang.Integer Código Curso
idProfessor Não java.lang.Integer Código Professor
format Não java.lang.String Formato do retorno (JSON/XML) default JSON
offset Não java.lang.Integer offset (número de registros a serem pulados na realização da consulta)
{
  "idProfessor (Integer)": null,
  "nome (String)": null,
  "cpf (String)": null,
  "rg (String)": null,
  "titulacao (String)": null,
  "escolaridade (String)": null,
  "posGraduacao (String)": null,
  "situacaoDocente (String)": null,
  "dataSituacaoDocente (Date)": null,
  "idInep (Long)": null,
  "grauGraduacao (String)": null,
  "email (String)": null,
  "dataNascimento (Date)": 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
}