Lista todos os Tipos de Processos Seletivos cadastrados na instituição.
Método: POST
Resposta: JSON/XML
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
token | Sim | java.lang.String | Token do usuário |
format | Sim | java.lang.String | Formato do retorno (JSON/XML) |
http://187.60.217.18:8080/academico/api/v1/basicos/tipos-de-processo-seletivo/
{ "idTipoProcessoSeletivo (Integer)": null, "descricao (String)": null, "codigoInep (String)": null, "naoParticipaCenso (Integer)": null, "provenienteTransferenciaExterna (Integer)": null, "provenienteTransferenciaInterna (Integer)": null, "padrao (Integer)": null, "id_org (Integer)": null }
Lista todos os graus de graduação cadastrados na instituição.
Método: POST
Resposta: JSON/XML
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
token | Sim | java.lang.String | Token do usuário |
format | Sim | java.lang.String | Formato do retorno (JSON/XML) |
http://187.60.217.18:8080/academico/api/v1/basicos/graus-de-graduacao/
{ "idGrauGraduacao (Integer)": null, "descricao (String)": null, "ordem (Integer)": null, "participaCenso (Integer)": null, "reprovarPeriodoAcimaMaxReprovacoes (Integer)": null, "tipo (String)": null, "numeroMaximoReprovacoesAprovParcial (Integer)": null, "naoPermitirProgressaoParcial (Integer)": null, "sincronizacaoDiretaAmbienteMoodle (Integer)": null, "reprovarMatriculaSemDisciplina (Integer)": null, "considerarOrdemInicio (Integer)": null, "representaPeriodoLetivo (Integer)": null, "sinteseSistemaAvaliacao (String)": null, "legendaHistoricoEscolar (String)": null, "legendaRelatorioFinal (String)": null, "naoApresentarDisciplinasPendentesPortal (Integer)": null, "validarCreditosExigidos (Integer)": null, "id_org (Integer)": null }
Lista todas as Unidades Físicas ativas da instituição.
Método: POST
Resposta: JSON/XML
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
token | Sim | java.lang.String | Token do usuário |
format | Sim | java.lang.String | Formato do retorno (JSON/XML) |
http://187.60.217.18:8080/academico/api/v1/basicos/unidades-fisicas/
{ "idUnidadeFisica (Integer)": null, "nome (String)": null, "nomeImpressao (String)": null, "sigla (String)": null, "logradouro (String)": null, "numero (String)": null, "bairro (String)": null, "cep (String)": null, "email (String)": null, "cnpj (String)": null, "fones (String)": null, "idCidade (Integer)": null, "status (String)": null, "dataAtivacao (Date)": null, "dataInativacao (Date)": null, "codigoInep (Integer)": null, "_cidade (String)": null, "_uf (String)": null, "_idEstado (Integer)": null, "_nomeResponsavel (String)": null, "_telefoneResponsavel (String)": null, "_celularResponsavel (String)": null, "_emailResponsavel (String)": null, "idPerfilResponsavel (Integer)": null, "naoApresentarNoFormularioAtendimento (Integer)": null, "id_org (Integer)": null }
Lista os prontuários para os parametros passados.
Método: POST
Resposta: JSON/XML
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
token | Sim | java.lang.String | Token do usuário |
format | Sim | java.lang.String | Formato do retorno (JSON/XML) |
idPerfil | Não | java.lang.Integer | Código Perfil |
dataInicio | Não | java.sql.Date | Prontuários criados a partir de |
dataFim | Não | java.sql.Date | Prontuários criados até |
idCategoria | Não | java.lang.Integer | Código categoria |
idSubCategoria | Não | java.lang.Integer | Código sub-categoria |
isAdvertencia | Não | java.lang.Integer | 0 (Sem Advertência), 1 (Com Advertência) |
offset | Sim | java.lang.Integer | Número de registros a serem pulados na realização da consulta (paginação) |
http://187.60.217.18:8080/academico/api/v1/prontuarios/listar-prontuarios/
{ "idMensagemProntuario (Integer)": null, "idUsuarioCriacao (Integer)": null, "pessoa (String)": null, "idPerfil (Integer)": null, "advertencia (Integer)": null, "mensagem (String)": null, "dataCriacao (Timestamp)": null, "lido (Integer)": null, "_usuario (String)": null, "_nome_perfil (String)": null, "_sexo_perfil (String)": null, "idProntuarioSubCategoria (Integer)": null, "_idProntuarioCategoria (Integer)": null, "_categoria (String)": null, "_subCategoria (String)": null, "_corCategoria (String)": null, "_categoriaEnviarNotificacaoAplicativo (Integer)": null, "id_org (Integer)": null }
Lista todos os Cursos Base cadastrados na instituição ou de uma organização específica.
Método: POST
Resposta: JSON/XML
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
token | Sim | java.lang.String | Token do usuário |
format | Sim | java.lang.String | Formato do retorno (JSON/XML) |
idOrg | Não | java.lang.Integer | Código da instituição |
http://187.60.217.18:8080/academico/api/v1/academico/cursos-base/
{ "idCursoBase (Integer)": null, "nomeImpressao (String)": null, "nomeImpressao2 (String)": null, "nomeImpressao3 (String)": null, "nomeReduzido (String)": null, "reconhecimento (String)": null, "dataReconhecimento (Date)": null, "dataPublicacaoReconhecimento (Date)": null, "secaoReconhecimento (String)": null, "paginaPublicacaoReconhecimento (String)": null, "observacaoReconhecimento (String)": null, "autorizacao (String)": null, "dataAutoricacao (Date)": null, "dataPublicacaoAutoricacao (Date)": null, "secaoAutorizacao (String)": null, "paginaPublicacaoAutorizacao (String)": null, "observacaoAutorizacao (String)": null, "renovacao (String)": null, "dataRenovacao (Date)": null, "dataPublicacaoRenovacao (Date)": null, "secaoRenovacao (String)": null, "paginaPublicacaoRenovacao (String)": null, "observacaoRenovacao (String)": null, "perfilProfissionalConclusao (String)": null, "grauAcademicoMasculino (String)": null, "grauAcademicoFeminino (String)": null, "regimeFuncionamento (String)": null, "autorizacaoUsoParecer (String)": null, "autorizacaoUsoHistorico (String)": null, "autorizacaoUsoFichaIndividual (String)": null, "codigoInep (String)": null, "numeroPublicacaoAutorizacao (String)": null, "numeroPublicacaoRenovacao (String)": null, "numeroPublicacaoReconhecimento (String)": null, "grauAcademico (String)": null, "generatorSequenciaMatricula (Integer)": null, "generatorSequenciaMatriculaMarcador (Integer)": null, "generatorCurrentNumeroMatriculaAlunoCursoIngresso (Integer)": null, "status (String)": null, "codigoCurso (String)": null, "_org (String)": null, "_orgNomeFantasia (String)": null, "portariaVigente (String)": null, "descricaoGaleria (String)": null, "naoOfertarMatriculaOnline (Integer)": null, "id_org (Integer)": null }
Lista todas as matrizes cadastradas na instituição ou de uma organização específica.
Método: POST
Resposta: JSON/XML
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
token | Sim | java.lang.String | Token do usuário |
format | Sim | java.lang.String | Formato do retorno (JSON/XML) |
idOrg | Não | java.lang.Integer | Código da instituição |
idGrauGraduacao | Não | java.lang.Integer | Código do Grau de Graduação |
http://187.60.217.18:8080/academico/api/v1/academico/matrizes/
{ "idCurso (Integer)": null, "idGrauGraduacao (Integer)": null, "idCursoBase (Integer)": null, "_nomeImpressao (String)": null, "_nomeImpressao2 (String)": null, "idProfessorCoordenador (Integer)": null, "nome (String)": null, "nomeRed (String)": null, "prazoConclusao (Integer)": null, "enfase (String)": null, "modalidade (String)": null, "horasAtividade (Integer)": null, "tipoAtividade (String)": null, "mediaMin (Double)": null, "mediaNormal (Double)": null, "frequencia (Double)": null, "recMedMin (Double)": null, "recMedNormal (Double)": null, "notaMenor (Double)": null, "notaMaior (Double)": null, "cargaHoraria (String)": null, "cargaHorariaTeorica (String)": null, "cargaHorariaPratica (String)": null, "cargaHorariaEstagio (String)": null, "prazoEm (String)": null, "podeTrancarPrimeiroPeriodo (Integer)": null, "prazoMaximoConclusao (Integer)": null, "habilidadesCompetencias (String)": null, "creditosExigidos (Double)": null, "idInep (Integer)": null, "idCentroCusto (Integer)": null, "_centroCusto (String)": null, "_codigoCentroCusto (String)": null, "idEixoTecnologico (Integer)": null, "idPlanoConta (Integer)": null, "_planoConta (String)": null, "idFormaPagamento (Integer)": null, "_formaPagamento (String)": null, "_descricaoGrauGraduacao (String)": null, "_tipoGrauGraduacao (String)": null, "descricao (String)": null, "tema (String)": null, "tipoCalculoFrequencia (String)": null, "periodicidade (String)": null, "status (String)": null, "naoApresentarParaUsuarioPolo (Integer)": null, "_idMoodleCategory (Integer)": null, "_codigoCurso (String)": null, "_statusCursoBase (String)": null, "cargaHorariaTcc (String)": null, "idDocumentoContrato (Integer)": null, "_documentoContrato (String)": null, "id_org (Integer)": null }
Retorna todos os sistemas de Avaliação vigentes.
Método: POST
Resposta: JSON/XML
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
token | Sim | java.lang.String | Token do usuário |
format | Sim | java.lang.String | Formato do retorno (JSON/XML) |
idOrg | Não | java.lang.Integer | Código da Organização |
http://187.60.217.18:8080/academico/api/v1/academico/sistemas-de-avaliacao/
{ "idSistemaAvaliacao (Integer)": null, "descricao (String)": null, "idDisciplina (Integer)": null, "formula (String)": null, "formulaExame (String)": null, "status (String)": null, "padrao (Integer)": null, "idFormulaCalculaNota (Integer)": null, "_ordemProximaAvaliacao (Integer)": null, "habilitarConfiguracaoNotas (Integer)": null, "mediaMin (Double)": null, "mediaNormal (Double)": null, "recMedMin (Double)": null, "recMedNormal (Double)": null, "notaMenor (Double)": null, "notaMaior (Double)": null, "frequencia (Double)": null, "tipoCalculoFrequencia (String)": null, "id_org (Integer)": null }
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 |
---|---|---|---|
token | Sim | java.lang.String | Token do usuário |
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 |
offset | Sim | java.lang.Integer | Número de registros a serem pulados na realização da consulta (paginação) |
http://187.60.217.18:8080/academico/api/v1/academico/turmas/disciplinas/
{ "idDisciplinaProfessor (Integer)": null, "id_professor (Integer)": null, "idTurma (Integer)": null, "idDisciplina (Integer)": null, "idSistemaAvaliacaoPeriodo (Integer)": null, "valorNormal (Double)": null, "quantVagas (Integer)": null, "matriculaObrigatoria (Integer)": null, "naoSeraOfertada (Integer)": null, "naoDisponivelRematricula (Integer)": null, "ead (Integer)": null, "hasCoRequisitos (Boolean)": null, "idDisciplinaProfessorReferencia (Integer)": null, "hasDisciplinasFilhas (Integer)": null, "hasDisciplinaPai (Integer)": null, "_disciplinaPai (String)": null, "_disciplinaPaiCodigo (Integer)": null, "_idCurso (Integer)": null, "_curso (String)": null, "_cursoBase (String)": null, "_professor (String)": null, "_professorEmail (String)": null, "_disciplina (String)": null, "_modalidade (String)": null, "_turma (String)": null, "_turno (String)": null, "_periodo (Integer)": null, "_descPeriodo (String)": null, "_descPeriodoNomeReduzido (String)": null, "id_periodo_letivo (Integer)": null, "_periodoLetivo (String)": null, "_periodoLetivoDataInicio (Date)": null, "_periodoLetivoDataTermino (Date)": null, "_cargaHoraria (Integer)": null, "_cargaHorariaCobrada (Integer)": null, "_avaliacao (String)": null, "_statusPeriodoLetivo (String)": null, "_statusTurma (String)": null, "_periodoTurma (Integer)": null, "_descPeriodoTurma (String)": null, "formula (String)": null, "formulaExame (String)": null, "avaliacoes (ArrayList)": null, "_idGrupoDisciplina (Integer)": null, "_grupo (String)": null, "_tipoGrupo (String)": null, "_descricaoOrg (String)": null, "possuiSubDisciplinas (Integer)": null, "disciplinaEquivalente (String)": null, "idSubDisciplina (Integer)": null, "_idDisciplinaPai (Integer)": null, "_subDisciplinaDescricao (String)": null, "_subDisciplinaCargaHoraria (Integer)": null, "_dataFechamentoDiarioClasse (Date)": null, "_dataAbonoFalta (Date)": null, "selecionar (boolean)": false, "_cartaConvite (CartaConvite)": null, "_idSistemaAvaliacao (Integer)": null, "_sistemaAvaliacao (String)": null, "_idFormulaCalculaNota (Integer)": null, "_formulaCalculaNota (String)": null, "_calculaSubFormulas (Integer)": null, "_classeCalculaNota (String)": null, "_idProfessorCoordenador (Integer)": null, "utilizaFrequenciaResumida (Integer)": null, "quantidadeAulas (Integer)": null, "_quantidadeAlunosMatriculados (Integer)": null, "_idUnidadeFisica (Integer)": null, "_complementaridade (String)": null, "_codigoMec (String)": null, "idCourseSectionMoodle (Integer)": null, "idCourseMoodle (Integer)": null, "_idCourseMoodle (Integer)": null, "_tipoCalculoFrequencia (String)": null, "habilitarIntegracaoBlackboard (Integer)": null, "_disciplinaHabilitaIntegracaoBlackboard (Integer)": null, "_idPerfilProfessor (Integer)": null, "_qtdeAulas (Integer)": null, "_idOrgTurma (Integer)": null, "_turmaConsolidada (Integer)": null, "_idIntegracaoDisciplina (String)": null, "_idGrupoAulaSelecionadoRematricula (Integer)": null, "_disciplinaValorNormal (Double)": null, "_matriculaWebSelecionavel (Integer)": 1, "_matriculaWebMotivoBloqueio (String)": null, "_idCicloModulo (Integer)": null, "_idModulo (Integer)": null, "_idModuloModular (Integer)": null, "_modulo (String)": null, "_cicloModulo (String)": null, "_tipoDisciplina (String)": null, "idDisciplinaEletiva (Integer)": null, "_qtdeEncontroCalendarioRotativo (Integer)": null, "id_org (Integer)": null }
Lista todas as Turmas da instituição ou de uma organização específica.
Método: POST
Resposta: JSON/XML
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
token | Sim | java.lang.String | Token do usuário |
format | Sim | java.lang.String | Formato do retorno (JSON/XML) |
idOrg | Não | java.lang.Integer | Código da instituição |
status | Não | java.lang.String | Status da turma (AGUARDANDO, ATIVA, CANCELADA, ENCERRADA) |
limit | Não | java.lang.Integer | Limite do resultado da consulta (padrão são 300 registros) |
http://187.60.217.18:8080/academico/api/v1/academico/turmas/
{ "idTurma (Integer)": null, "idPeriodoLetivo (Integer)": null, "idCurso (Integer)": null, "idUnidadeFisica (Integer)": null, "idTurmaBase (Integer)": null, "idCentroCusto (Integer)": null, "idParecerDescritivo (Integer)": null, "idProfessorResponsavel (Integer)": null, "idTurmaDestino (Integer)": null, "mediaMin (Double)": null, "mediaNormal (Double)": null, "frequencia (Double)": null, "recMedMin (Double)": null, "recMedNormal (Double)": null, "nome (String)": null, "nomeRed (String)": null, "descricao (String)": null, "status (String)": null, "valorTotal (Double)": null, "notaMenor (Double)": null, "notaMaior (Double)": null, "turno (String)": null, "consolidado (Integer)": null, "_idCursoBase (Integer)": null, "_nomeCurso (String)": null, "_nomeCursoRed (String)": null, "_cursoBase (String)": null, "_descricaoPeriodo (String)": null, "_unidadeFisica (String)": null, "_turmaBase (String)": null, "_situacaoPeriodoLetivo (String)": null, "_turmaDestino (String)": null, "_centroCusto (String)": null, "idCidade (Integer)": null, "descCidade (String)": null, "idPeriodoItem (Integer)": null, "_nomePeriodoItem (String)": null, "_nomeReduzidoPeriodoItem (String)": null, "_ordemPeriodoItem (Integer)": null, "dataInicio (Date)": null, "dataFim (Date)": null, "observacao (String)": null, "dataAbonoFalta (Date)": null, "idMetodoRecebimento (Integer)": null, "_metodoRecebimento (String)": null, "dataFechamentoDiarioClasse (Date)": null, "habilitarAcessoPlataformaBlackBoard (Integer)": null, "habilitarAcessoPlataformaBibliotecaPearson (Integer)": null, "nucleoComum (Integer)": null, "idCourseMoodle (Integer)": null, "habilitadoAtendimentoInternet (Integer)": null, "_idGrauGraduacao (Integer)": null, "_grauGraduacao (String)": null, "_idMoodleCategory (Integer)": null, "digitalDocCodPasta (Integer)": null, "digitalDocDescricaoPasta (String)": null, "digitalDocCaminhoFolder (String)": null, "_periodoLetivoDataInicio (Date)": null, "_periodoLetivoDataTermino (Date)": null, "habilitadoVenda (Integer)": null, "naoApresentarParaMatriculaNoPortal (Integer)": null, "disponivelParaMatriculaOnline (Integer)": null, "calendarioRotativoSegunda (Integer)": null, "calendarioRotativoTerca (Integer)": null, "calendarioRotativoQuarta (Integer)": null, "calendarioRotativoQuinta (Integer)": null, "calendarioRotativoSexta (Integer)": null, "calendarioRotativoSabado (Integer)": null, "calendarioRotativoDomingo (Integer)": null, "calendarioRotativoTurmaFechada (Integer)": null, "_qtdeDisciplinas (Integer)": null, "calendarioRotativoIdPerfilContratante (Integer)": null, "_contratante (String)": null, "id_org (Integer)": null }
Lista todos os Períodos Letivos da instituição ou de uma organização específica.
Método: POST
Resposta: JSON/XML
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
token | Sim | java.lang.String | Token do usuário |
format | Sim | java.lang.String | Formato do retorno (JSON/XML) |
idOrg | Não | java.lang.Integer | Código da instituição |
status | Não | java.lang.String | Status do período (ABERTO,CANCELADO,ENCERRADO) |
http://187.60.217.18:8080/academico/api/v1/academico/periodos-letivos/
{ "idPeriodoLetivo (Integer)": null, "descricao (String)": null, "descricaoEspecial (String)": null, "dataInicio (Date)": null, "dataTermino (Date)": null, "situacao (String)": null, "periodo_especial (String)": null, "ano (Integer)": null, "periodoAtual (Integer)": null, "diasLetivos (Integer)": null, "tipo (String)": null, "_descricaoOrg (String)": null, "idProximoPeriodoLetivo (Integer)": null, "dataInicioRematricula (Date)": null, "dataTerminoRematricula (Date)": null, "dataLimiteAtualizacaoContrato (Date)": null, "dataValidadeBiblioteca (Date)": null, "_descricaoProximoPeriodoLetivo (String)": null, "habilitarIntegracaoBlackboard (Integer)": null, "semestre (Integer)": null, "consolidado (Integer)": null, "ead (Integer)": null, "_idMoodleCategory (Integer)": null, "digitalDocCodPasta (Integer)": null, "digitalDocDescricaoPasta (String)": null, "naoApresentarNoPortal (Integer)": null, "_qtdeSubPeriodo (Integer)": null, "processaScore (Integer)": null, "lmsDataInicio (Date)": null, "lmsDataTermino (Date)": null, "periodoAno (String)": null, "habilitadoParaInscricaoEad (Integer)": null, "sincronizarDadosAppMobile (Integer)": null, "id_org (Integer)": null }
Lista todas as disciplinas dos Cursos Matriz.
Método: POST
Resposta: JSON/XML
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
token | Sim | java.lang.String | Token do usuário |
format | Sim | java.lang.String | Formato do retorno (JSON/XML) |
idCurso | Não | java.lang.Integer | Código da Matriz Curricular (Curso) |
descDisciplina | Não | java.lang.String | Descrição da Disciplina, será aplicado em uma instrução "like" |
offset | Sim | java.lang.Integer | Número de registros a serem pulados na realização da consulta (paginação) |
http://187.60.217.18:8080/academico/api/v1/academico/disciplinas/curso
{ "idDisciplina (Integer)": null, "idDisciplinaBase (Integer)": null, "idDisciplinaPai (Integer)": null, "idGrupoDisciplina (Integer)": null, "idPeriodo (Integer)": null, "descricao (String)": null, "nomeRed (String)": null, "cargaHoraria (Integer)": null, "creditos (Double)": null, "valorNormal (Double)": null, "ordem (Integer)": null, "validaConflitoHorarioRematricula (Integer)": null, "complementaridade (String)": null, "idCursoEnfase (Integer)": null, "tipo (String)": null, "avaliacao (String)": null, "desconsiderarConflitoHorarioRematricula (Integer)": null, "_codigo (String)": null, "_idCurso (Integer)": null, "_curso (String)": null, "_periodo (String)": null, "_periodoOrdem (Integer)": null, "_periodoRed (String)": null, "_periodoDescricao (String)": null, "_cursoRed (String)": null, "_grupoDisciplina (String)": null, "_disciplinaPai (String)": null, "hasFilhas (Integer)": null, "id_professor (Integer)": null, "_servico (String)": null, "_planoConta (String)": null, "cargaHorariaCobrada (Integer)": null, "cargaHorariaPratica (Integer)": null, "cargaHorariaTeorica (Integer)": null, "cargaHorariaCorrida (Double)": null, "mostrarNotaHistorico (Integer)": null, "mostrarFreqHistorico (Integer)": null, "utilizaFrequenciaResumida (Integer)": null, "quantidadeAulas (Integer)": null, "naoContabilizaReprovacao (Integer)": null, "codigoMec (String)": null, "codigoInep (Integer)": null, "naoContabilizarRankingNotas (Integer)": null, "_nomeCursoBase (String)": null, "_idCursoBase (Integer)": null, "modalidade (String)": null, "habilitarIntegracaoBlackboard (Integer)": null, "habilitarIntegracaoIesde (Integer)": null, "desabilitarIntegracaoSisfad (Integer)": null, "_idOrgCurso (Integer)": null, "idIntegracao (String)": null, "idIntegracao2 (String)": null, "idModulo (Integer)": null, "idCicloModulo (Integer)": null, "_modulo (String)": null, "_cicloModulo (String)": null, "pesoAgendamento (Integer)": null, "naoPermitirAgendamentoAvaliacao (Integer)": null, "naoAdicionarCalendarioRotativo (Integer)": null, "quantidadeEncontroCalendarioRotativo (Integer)": null, "id_org (Integer)": null }
Lista todas as matrículas alunos da instituição.
Método: POST
Resposta: JSON/XML
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
token | Sim | java.lang.String | Token do usuário |
format | Sim | java.lang.String | Formato do retorno (JSON/XML) |
idOrg | Não | java.lang.Integer | Código do Organização |
idAluno | Não | java.lang.Integer | Código do Aluno |
idPeriodoLetivo | Não | java.lang.Integer | Código do Período Letivo |
dataCriacaoInicio | Não | java.sql.Date | Data início de criação da matrícula |
dataCriacaoFim | Não | java.sql.Date | Data final de criação da matrícula |
dataAlteracaoInicio | Não | java.sql.Date | Data início de alteração da inscrição do curso ingresso |
dataAlteracaoFim | Não | java.sql.Date | Data final de alteração da inscrição do curso ingresso |
nomeAluno | Não | java.lang.String | Nome do aluno (será aplicado em um comando 'LIKE' |
podeSairSozinho | Não | java.lang.Integer | Se o aluno pode sair sozinho (Usar 0 (zero) ou 1 (um) |
offset | Sim | java.lang.Integer | Número de registros a serem pulados na realização da consulta (paginação) |
http://187.60.217.18:8080/academico/api/v1/academico/aluno/matriculas/todas-matriculas/listar/
{ "idAluno (Integer)": null, "ra (String)": null, "idMatricula (Integer)": null, "nome (String)": null, "email (String)": null, "cpf (String)": null, "rg (String)": null, "dataNascimento (Date)": null, "endereco (String)": null, "complemento (String)": null, "bairro (String)": null, "numero (String)": null, "cep (String)": null, "idCidade (Integer)": null, "cidade (String)": null, "idEstado (Integer)": null, "estado (String)": null, "uf (String)": null, "telefoneRes (String)": null, "telefoneCom (String)": null, "celular (String)": null, "login (String)": null, "senha (String)": null, "idPeriodoLetivo (Integer)": null, "periodoLetivo (String)": null, "idCursoMatriz (Integer)": null, "matrizCurricular (String)": null, "idCursoBase (Integer)": null, "curso (String)": null, "idTurma (Integer)": null, "turma (String)": null, "statusMatricula (String)": null, "idOrg (Integer)": null, "organizacao (String)": null, "id_org (Integer)": null }
Lista todas as matrículas alunos da instituição.
Método: POST
Resposta: JSON/XML
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
token | Sim | java.lang.String | Token do usuário |
format | Sim | java.lang.String | Formato do retorno (JSON/XML) |
idOrg | Não | java.lang.Integer | Código do Organização |
idAluno | Não | java.lang.Integer | Código do Aluno |
idPeriodoLetivo | Não | java.lang.Integer | Código do Período Letivo |
idTurma | Não | java.lang.Integer | Código da Turma |
dataCriacaoInicio | Não | java.sql.Date | Data início de criação da matrícula |
dataCriacaoFim | Não | java.sql.Date | Data final de criação da matrícula |
dataAlteracaoInicio | Não | java.sql.Date | Data início de alteração da inscrição do curso ingresso |
dataAlteracaoFim | Não | java.sql.Date | Data final de alteração da inscrição do curso ingresso |
nomeAluno | Não | java.lang.String | Nome do aluno (será aplicado em um comando 'LIKE' |
podeSairSozinho | Não | java.lang.Integer | Se o aluno pode sair sozinho (Usar 0 (zero) ou 1 (um) |
offset | Sim | java.lang.Integer | Número de registros a serem pulados na realização da consulta (paginação) |
http://187.60.217.18:8080/academico/api/v1/academico/aluno/matriculas/matriculas/listar/
{ "idMatricula (Integer)": null, "idPeriodoLetivo (Integer)": null, "idAluno (Integer)": null, "idFormaPagamento (Integer)": null, "idCurso (Integer)": null, "idTurma (Integer)": null, "idAlunoCursoIngresso (Integer)": null, "idUnidadeFisica (Integer)": null, "_idUnidadeFisica (Integer)": null, "_unidadeFisica (String)": null, "statusDescricao (String)": null, "status (String)": null, "_ra (String)": null, "_alunoNome (String)": null, "_sexo (String)": null, "_idProximoPeriodoLetivo (Integer)": null, "_periodoLetivo (String)": null, "_idPerfil (Integer)": null, "_idTipoProcessoSeletivo (Integer)": null, "_celular (String)": null, "_situacaoPeriodo (String)": null, "_idCursoBase (Integer)": null, "_turma (String)": null, "_curso (String)": null, "_cursoBase (String)": null, "_valorTotalTurma (Double)": null, "_statusTurma (String)": null, "statusObs (String)": null, "statusIesDestino (String)": null, "statusCurso (String)": null, "statusData (Date)": null, "dataMatricula (Date)": null, "dataAtivacao (Date)": null, "dataTrancamento (Date)": null, "ativadaAutomaticamente (Integer)": null, "desconto (Double)": null, "valorFinal (Double)": null, "valorParcela (Double)": null, "formaPagamento (String)": null, "observacao (String)": null, "isReposicao (Integer)": null, "isFormaPagamento (Integer)": null, "diaVencimentoFormaPagamento (Integer)": null, "mesInicioFormaPagamento (Integer)": null, "anoInicioFormaPagamento (Integer)": null, "tipoDiaFormaPagamento (String)": null, "numeroParcelas (Integer)": null, "dataPrimeiraParcela (Date)": null, "_diaVencimentoFormaPagamento (Integer)": null, "_mesInicioFormaPagamento (Integer)": null, "_anoInicioFormaPagamento (Integer)": null, "_tipoDiaFormaPagamento (String)": null, "_numeroParcelas (Integer)": null, "contratoEntregue (Integer)": null, "ipAceiteContrato (String)": null, "dataAceiteContrato (Timestamp)": null, "_tipoCurso (String)": null, "_nomeCurso (String)": null, "_idGrauGraduacao (Integer)": null, "_idMetodoRecebimentoTurma (Integer)": null, "_metodoRecebimento (String)": null, "_idCentroCustoTurma (Integer)": null, "_descricaoOrg (String)": null, "_nomeReduzidoOrg (String)": null, "numeroDiarioClasse (Integer)": null, "dataRegistroNumeroDiarioClasse (Date)": null, "idContrato (Integer)": null, "idVendedor (Integer)": null, "_statusAlunoCursoIngresso (String)": null, "_idCourseMoodle (Integer)": null, "_dataInicioCursoIngresso (Date)": null, "dataInicio (Date)": null, "dataFim (Date)": null, "_periodoLetivoEad (Integer)": null, "consolidado (Integer)": null, "_aluno (String)": null, "_idProfessorResponsavelTurma (Integer)": null, "_alunoPodeSairSozinho (Integer)": null, "idCampanha (Integer)": null, "_contrato (ContratoMatricula)": null, "idModulo (Integer)": null, "_modulo (String)": null, "idContratoRef (Integer)": null, "origem (String)": null, "id_org (Integer)": null }
Lista todas as últimas matrículas alunos da instituição.
Método: POST
Resposta: JSON/XML
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
token | Sim | java.lang.String | Token do usuário |
format | Sim | java.lang.String | Formato do retorno (JSON/XML) |
idOrg | Não | java.lang.Integer | Código do Organização |
idAluno | Não | java.lang.Integer | Código do Aluno |
idPeriodoLetivo | Não | java.lang.Integer | Código do Período Letivo |
dataCriacaoInicio | Não | java.sql.Date | Data início de criação da matrícula |
dataCriacaoFim | Não | java.sql.Date | Data final de criação da matrícula |
dataAlteracaoInicio | Não | java.sql.Date | Data início de alteração da inscrição do curso ingresso |
dataAlteracaoFim | Não | java.sql.Date | Data final de alteração da inscrição do curso ingresso |
nomeAluno | Não | java.lang.String | Nome do aluno (será aplicado em um comando 'LIKE' |
offset | Sim | java.lang.Integer | Número de registros a serem pulados na realização da consulta (paginação) |
http://187.60.217.18:8080/academico/api/v1/academico/aluno/matriculas/ultimas-matriculas/listar/
{ "idAluno (Integer)": null, "ra (String)": null, "idMatricula (Integer)": null, "nome (String)": null, "email (String)": null, "cpf (String)": null, "rg (String)": null, "dataNascimento (Date)": null, "endereco (String)": null, "complemento (String)": null, "bairro (String)": null, "numero (String)": null, "cep (String)": null, "idCidade (Integer)": null, "cidade (String)": null, "idEstado (Integer)": null, "estado (String)": null, "uf (String)": null, "telefoneRes (String)": null, "telefoneCom (String)": null, "celular (String)": null, "login (String)": null, "senha (String)": null, "idPeriodoLetivo (Integer)": null, "periodoLetivo (String)": null, "idCursoMatriz (Integer)": null, "matrizCurricular (String)": null, "idCursoBase (Integer)": null, "curso (String)": null, "idTurma (Integer)": null, "turma (String)": null, "statusMatricula (String)": null, "idOrg (Integer)": null, "organizacao (String)": null, "id_org (Integer)": null }
Lista todas as disciplinas matriculadas dos alunos da instituição.
Método: POST
Resposta: JSON/XML
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
token | Sim | java.lang.String | Token do usuário |
format | Sim | java.lang.String | Formato do retorno (JSON/XML) |
idOrg | Não | java.lang.Integer | Código do Organização |
idAluno | Não | java.lang.Integer | Código do Aluno |
idPeriodoLetivo | Não | java.lang.Integer | Código do Período Letivo |
idTurma | Não | java.lang.Integer | Código do Turma |
idCurso | Não | java.lang.Integer | Código do Curso |
idMatricula | Não | java.lang.Integer | Código da Matrícula |
dataAlteracaoInicio | Não | java.sql.Date | Data início de alteração da inscrição do curso ingresso (DD/MM/YYYY) |
dataAlteracaoFim | Não | java.sql.Date | Data final de alteração da inscrição do curso ingresso (DD/MM/YYYY) |
nomeAluno | Não | java.lang.String | Nome do aluno (será aplicado em um comando 'LIKE') |
nomeDisciplina | Não | java.lang.String | Nome da Disciplina (será aplicado em um comando 'LIKE') |
statusMatricula | Não | java.lang.String | Status da Matrícula |
statusMatriculaDisciplina | Não | java.lang.String | Status da Matrícula Disciplina |
offset | Sim | java.lang.Integer | Número de registros a serem pulados na realização da consulta (paginação) |
http://187.60.217.18:8080/academico/api/v1/academico/aluno/matriculas/disciplinas/
{ "idAluno (Integer)": null, "ra (String)": null, "email (String)": null, "login (String)": null, "senha (String)": null, "cpf (String)": null, "dataInicioPeriodoLetivo (Date)": null, "dataTerminoPeriodoLetivo (Date)": null, "idMatricula (Integer)": null, "idMatriculaDisciplina (Integer)": null, "nome (String)": null, "idPeriodoLetivo (Integer)": null, "periodoLetivo (String)": null, "idCursoMatriz (Integer)": null, "matrizCurricular (String)": null, "idCursoBase (Integer)": null, "curso (String)": null, "idTurma (Integer)": null, "turma (String)": null, "statusMatricula (String)": null, "idOrg (Integer)": null, "organizacao (String)": null, "idDisciplina (Integer)": null, "disciplina (String)": null, "statusMatriculaDisciplina (String)": null, "mediaFinal (Double)": null, "quantFaltas (Integer)": null, "id_org (Integer)": null }
Lista os repponsáveis dos alunos.
Método: POST
Resposta: JSON/XML
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
token | Sim | java.lang.String | Token do usuário |
format | Sim | java.lang.String | Formato do retorno (JSON/XML) |
idCursoBase | Não | java.lang.Integer | Código do Curso Base |
idPeriodoLetivo | Não | java.lang.Integer | Código do Período Letivo |
raAluno | Não | java.lang.String | RA do aluno |
nomeAluno | Não | java.lang.String | Nome do aluno (será aplicado em um comando 'LIKE' |
offset | Sim | java.lang.Integer | Número de registros a serem pulados na realização da consulta (paginação) |
http://187.60.217.18:8080/academico/api/v1/academico/aluno/responsavel/listar/
{ "idPerfilResponsavel (Integer)": null, "idPerfil (Integer)": null, "parentesco (String)": null, "reside (String)": null, "responsavelLegal (Integer)": null, "naoPodeAcessarPortalAluno (Integer)": null, "idResponsavel (Integer)": null, "_nome (String)": null, "_cpf (String)": null, "_rg (String)": null, "_fone (String)": null, "_celular (String)": null, "rendaComprovada (Integer)": null, "retirarAluno (Integer)": null, "retirarAlunoObservacao (String)": null, "_bairroResponsavel (String)": null, "_logradouroResponsavel (String)": null, "_NumeroEnderecoResponsavel (String)": null, "_cepResponsavel (String)": null, "_cidadeResponsavel (String)": null, "_ufDescricaoResponsavel (String)": null, "_ufSiglaResponsavel (String)": null, "_rgResponsavel (String)": null, "_sexoResponsavel (String)": null, "_estadoCivilResponsavel (String)": null, "_dataNascimentoResponsavel (Date)": null, "_emailResponsavel (String)": null, "_numeroResponsavel (String)": null, "_nomeAluno (String)": null, "id_org (Integer)": null }
Esse método retorna os alunos e uma lista de todos os responsáveis cadastrados, além de retornar as matrículas ATIVAS do aluno
Método: POST
Resposta: JSON/XML
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
token | Sim | java.lang.String | Token do usuário |
format | Sim | java.lang.String | Formato do retorn (JSON/XML) |
idAluno | Sim | java.lang.Integer | Código do aluno |
http://187.60.217.18:8080/academico/api/v1/academico/aluno/aluno-responsaveis
{ "responsaveis (ArrayList)": [], "matriculas (ArrayList)": [], "idAluno (Integer)": null, "idPerfil (Integer)": null, "ra (String)": null, "nome (String)": null, "habilidadeMotora (String)": null, "cpf (String)": null, "_cpf (String)": null, "rg (String)": null, "rgOrgaoExpedidor (String)": null, "rgDataEmissao (Date)": null, "rne (String)": null, "pai (String)": null, "mae (String)": null, "cpfPai (String)": null, "cpfMae (String)": null, "dataNascimento (Date)": null, "estadoCivil (String)": null, "sexo (String)": null, "foto (String)": null, "email (String)": null, "idNacionalidade (Integer)": null, "_nascionalidade (String)": null, "idReligiao (Integer)": null, "_religiao (String)": null, "idNecessidadeEspecial (Integer)": null, "_necessidadeEspecial (String)": null, "idCidadeNatural (Integer)": null, "_naturalidade (String)": null, "_ufNaturalidade (String)": null, "idCor (Integer)": null, "_cor (String)": null, "_codigoCorInep (Integer)": null, "status (String)": null, "senha (String)": null, "login (String)": null, "idCidade (Integer)": null, "bairro (String)": null, "logradouro (String)": null, "cep (String)": null, "complemento (String)": null, "localidade (String)": null, "numero (String)": null, "_cidade (String)": null, "_estado (String)": null, "_uf (String)": null, "_idEstado (Integer)": null, "celular (String)": null, "fone (String)": null, "fax (String)": null, "foneComercial (String)": null, "tituloNumero (String)": null, "tituloZona (String)": null, "tituloSecao (String)": null, "tituloDataExpedicao (Date)": null, "idMunicipioTitulo (Integer)": null, "descMunicipioTitulo (String)": null, "certidaoNumero (String)": null, "certidaoFolha (String)": null, "certidaoLivro (String)": null, "certidaoCartorio (String)": null, "certidaoDataEmissao (Date)": null, "certidaoUf (String)": null, "carteiraNumero (String)": null, "carteiraSerie (String)": null, "carteiraDataExpedicao (Date)": null, "carteiraUf (String)": null, "reservistaRa (String)": null, "reservistaCategoria (String)": null, "reservistaData (Date)": null, "reservistaOrgaoExpedidor (String)": null, "observacao (String)": null, "alunoSairSozinho (Integer)": null, "idEquipeJogosEscolares (Integer)": null, "idProfissao (Integer)": null, "idEmpresa (Integer)": null, "cargo (String)": null, "_profissao (String)": null, "_empresa (String)": null, "nomeBanco (String)": null, "numeroBanco (String)": null, "agencia (String)": null, "conta (String)": null, "favorecido (String)": null, "rendaComprovada (Integer)": null, "isSelected (boolean)": false, "_foneFormatado (String)": null, "_celularFormatado (String)": null, "idInep (Long)": null, "raEstadual (String)": null, "autorizaUsoImagem (Integer)": null, "_idioma (String)": null, "_dependentes (Integer)": null, "_desejaReceberInformacoes (Integer)": null, "utilizaTransportePublico (Integer)": null, "poderPublicoResponsavelTransporte (Integer)": null, "tipoTransportePublico (String)": null, "id_org (Integer)": null }
Lista todos os cursos ingressos dos alunos da instituição.
Método: POST
Resposta: JSON/XML
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
token | Sim | java.lang.String | Token do usuário |
format | Sim | java.lang.String | Formato do retorno (JSON/XML) |
idOrg | Não | java.lang.Integer | Código do Organização |
idAluno | Não | java.lang.Integer | Código do Aluno |
dataAlteracaoInicio | Não | java.sql.Date | Data início de alteração da inscrição do curso ingresso |
dataAlteracaoFim | Não | java.sql.Date | Data final de alteração da inscrição do curso ingresso |
nomeAluno | Não | java.lang.String | Nome do aluno (será aplicado em um comando 'LIKE' |
offset | Sim | java.lang.Integer | Número de registros a serem pulados na realização da consulta (paginação) |
http://187.60.217.18:8080/academico/api/v1/academico/aluno/cursos-ingressos/listar/
{ "idAlunoCursoIngresso (Integer)": null, "idTipoProcessoSeletivo (Integer)": null, "idAluno (Integer)": null, "idCurso (Integer)": null, "idUnidadeFisica (Integer)": null, "idInscricao (Integer)": null, "idTurmaBase (Integer)": null, "idAtendimento (Integer)": null, "idCursoEnfase (Integer)": null, "codigoEstadual (String)": null, "status (String)": null, "dataCadastro (Date)": null, "dataInicioCurso (Date)": null, "dataConclusao (Date)": null, "dataColacao (Date)": null, "dataTrancamento (Date)": null, "dataExpedicaoDiploma (Date)": null, "dataPrevFormatura (Date)": null, "estagioData (Date)": null, "estagioHoras (String)": null, "periodoIngresso (String)": null, "tituloMonografia (String)": null, "tipoMonografia (String)": null, "notaMonografia (Double)": null, "dataMonografia (Date)": null, "idProfessorOrientador (Integer)": null, "_nomeProfessorOrientador (String)": null, "ignorarEquivalenciaCursoConcluido (Integer)": null, "_curso (String)": null, "_cursoRed (String)": null, "_alunoNome (String)": null, "_dataNascimentoAluno (Date)": null, "_ra (String)": null, "_processoSeletivo (String)": null, "_unidadeFisica (String)": null, "_permiteTrancarPrimeiroPeriodo (Integer)": null, "_horasAtividadeExigidas (Integer)": null, "_sexo (String)": null, "_idPerfil (Integer)": null, "_idCursoBase (Integer)": null, "_idGrauGraduacao (Integer)": null, "_grauGraduacao (String)": null, "_tipoGrauGraduacao (String)": null, "_idEditalVestibular (Integer)": null, "_cargaHorariaCurso (Integer)": null, "_creditosExigidos (Double)": null, "turno (String)": null, "classificacao (String)": null, "pontos (String)": null, "vagas (String)": null, "numeroChamada (String)": null, "dataVestibular (Date)": null, "idInstituicao (Integer)": null, "_instituicao (String)": null, "idTurma (Integer)": null, "naoParticipaCenso (Integer)": null, "curso (Curso)": null, "processoSeletivo (TipoProcessoSeletivo)": null, "observacaoProcessoSeletivo (String)": null, "idCursoIngressoOrigem (Integer)": null, "situacaoEnadeIniciante (String)": null, "dataEnadeIniciante (Date)": null, "observacaoEnadeIniciante (String)": null, "situacaoEnadeConcluinte (String)": null, "dataEnadeConcluinte (Date)": null, "observacaoEnadeConcluinte (String)": null, "idInstituicaoDiploma (Integer)": null, "nomeDiploma (String)": null, "processo (String)": null, "registro (String)": null, "dataRegistro (Date)": null, "livro (String)": null, "nomeReitor (String)": null, "folha (String)": null, "percentualCursado (Double)": null, "numeroMatricula (Integer)": null, "alunoProcedenteEscolaPublica (String)": null, "_descricaoOrg (String)": null, "_cursoPermiteInscricaoWEB (Integer)": null, "_nomeImpressaoCursoBase (String)": null, "notaRedacaoProcessoSeletivo (Double)": null, "dataAceiteOrientadorMonografia (Date)": null, "temaMonografia (String)": null, "_reconhecimento (String)": null, "_dataReconhecimento (Date)": null, "_dataPublicacaoReconhecimento (Date)": null, "_observacaoReconhecimento (String)": null, "_autorizacao (String)": null, "_dataAutoricacao (Date)": null, "_dataPublicacaoAutoricacao (Date)": null, "_observacaoAutorizacao (String)": null, "_renovacao (String)": null, "_dataRenovacao (Date)": null, "_dataPublicacaoRenovacao (Date)": null, "_observacaoRenovacao (String)": null, "idInstituicaoOrigem (Integer)": null, "dataRetiradaDiploma (Date)": null, "dataPublicacaoDiploma (Date)": null, "idInstituicaoExpedidoraDiploma (Integer)": null, "_aluno (String)": null, "_cpf (String)": null, "_rg (String)": null, "_login (String)": null, "_senha (String)": null, "_email (String)": null, "_fone (String)": null, "_celular (String)": null, "_dataNascimento (Date)": null, "id_org (Integer)": null }
Lista todos os alunos da instituição com diversos filtros. Caso não seja informado nenhum filtro, a consulta irá retornar apenas os primeiros 1000 registros.
Método: POST
Resposta: JSON/XML
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
token | Sim | java.lang.String | Token do usuário |
format | Sim | java.lang.String | Formato do retorno (JSON/XML) |
tipo | Sim | java.lang.String |
Tipo do resultado da busca: -BASICA: somente os dados básicos do aluno; -COMPLETA:todos os dados do aluno; |
idOrg | Não | java.lang.Integer | Código do Organização |
filtrarPor | Não | java.lang.String | Flag do campo de referência para a consulta (CPF, RA, NOME ou ID_ALUNO) |
termo | Não | java.lang.String | Conteúdo para a busca |
dataAlteracaoInicio | Não | java.sql.Date | Data início de alteração da inscrição do aluno |
dataAlteracaoFim | Não | java.sql.Date | Data final de alteração da inscrição do aluno |
isSomenteComCursoIngressoAtivo | Não | boolean | Somente alunos que possuem um Curso Ingresso ativo |
isSomenteComMatriculaAtiva | Não | boolean | Somente alunos que possuem um Matrícula ativa |
idPeriodoLetivo | Não | java.lang.Integer | Que tenha uma matrícula no Período Letivo |
podeSairSozinho | Não | java.lang.Integer | Se o aluno pode sair sozinho (Usar 0 (zero) ou 1 (um) |
offset | Sim | java.lang.Integer | Número de registros a serem pulados na realização da consulta (paginação) |
http://187.60.217.18:8080/academico/api/v1/academico/aluno/
{ "idAluno (Integer)": null, "idPerfil (Integer)": null, "ra (String)": null, "nome (String)": null, "habilidadeMotora (String)": null, "cpf (String)": null, "_cpf (String)": null, "rg (String)": null, "rgOrgaoExpedidor (String)": null, "rgDataEmissao (Date)": null, "rne (String)": null, "pai (String)": null, "mae (String)": null, "cpfPai (String)": null, "cpfMae (String)": null, "dataNascimento (Date)": null, "estadoCivil (String)": null, "sexo (String)": null, "foto (String)": null, "email (String)": null, "idNacionalidade (Integer)": null, "_nascionalidade (String)": null, "idReligiao (Integer)": null, "_religiao (String)": null, "idNecessidadeEspecial (Integer)": null, "_necessidadeEspecial (String)": null, "idCidadeNatural (Integer)": null, "_naturalidade (String)": null, "_ufNaturalidade (String)": null, "idCor (Integer)": null, "_cor (String)": null, "_codigoCorInep (Integer)": null, "status (String)": null, "senha (String)": null, "login (String)": null, "idCidade (Integer)": null, "bairro (String)": null, "logradouro (String)": null, "cep (String)": null, "complemento (String)": null, "localidade (String)": null, "numero (String)": null, "_cidade (String)": null, "_estado (String)": null, "_uf (String)": null, "_idEstado (Integer)": null, "ddd (String)": null, "celular (String)": null, "fone (String)": null, "fax (String)": null, "foneComercial (String)": null, "tituloNumero (String)": null, "tituloZona (String)": null, "tituloSecao (String)": null, "tituloDataExpedicao (Date)": null, "idMunicipioTitulo (Integer)": null, "descMunicipioTitulo (String)": null, "certidaoNumero (String)": null, "certidaoFolha (String)": null, "certidaoLivro (String)": null, "certidaoCartorio (String)": null, "certidaoDataEmissao (Date)": null, "certidaoUf (String)": null, "carteiraNumero (String)": null, "carteiraSerie (String)": null, "carteiraDataExpedicao (Date)": null, "carteiraUf (String)": null, "reservistaRa (String)": null, "reservistaCategoria (String)": null, "reservistaData (Date)": null, "reservistaOrgaoExpedidor (String)": null, "observacao (String)": null, "alunoSairSozinho (Integer)": null, "idEquipeJogosEscolares (Integer)": null, "idProfissao (Integer)": null, "idEmpresa (Integer)": null, "cargo (String)": null, "_profissao (String)": null, "_empresa (String)": null, "nomeBanco (String)": null, "numeroBanco (String)": null, "agencia (String)": null, "conta (String)": null, "favorecido (String)": null, "rendaComprovada (Integer)": null, "isSelected (boolean)": false, "_foneFormatado (String)": null, "_celularFormatado (String)": null, "idInep (Long)": null, "raEstadual (String)": null, "autorizaUsoImagem (Integer)": null, "transacoes (ArrayList)": [], "_idioma (String)": null, "_dependentes (Integer)": null, "_desejaReceberInformacoes (Integer)": null, "utilizaTransportePublico (Integer)": null, "poderPublicoResponsavelTransporte (Integer)": null, "tipoTransportePublico (String)": null, "_contrato (ContratoMatricula)": null, "cursosIngresso (ArrayList)": [], "id_org (Integer)": null }
Permite cadastrar um perfil de pessoa física. Caso o CPF informado já esteja cadastrado, serão retornados os dados da pessoa existente na base de dados.
Método: POST
Resposta: JSON/XML
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
token | Sim | java.lang.String | Token do usuário |
format | Sim | java.lang.String | Formato do retorno (JSON/XML) |
idCliente | Sim | java.lang.Integer | Código do Cliente |
nome | Sim | java.lang.String | Nome da Pessoa física |
estrangeiro | Sim | boolean | Flag para informar se o perfil é estrangeiro (Irá obrigar informar o CPF ou RNE) |
rne | Não | java.lang.String | RNE |
cpf | Não | java.lang.String | CPF |
rg | Não | java.lang.String | Nùmero do RG |
rgOrgaoExpedidor | Não | java.lang.String | Órgão Expedidor |
rgDataEmissao | Não | java.sql.Date | Data de emissão do RG |
pai | Não | java.lang.String | Nome do Pai |
mae | Não | java.lang.String | Nome da Mãe |
cpfPai | Não | java.lang.String | CPF do Pai |
cpfMae | Não | java.lang.String | CPF da Mãe |
dataNascimento | Não | java.sql.Date | Data de Nascimento |
estadoCivil | Sim | java.lang.String | Estado Civil (SOLTEIRO, CASADO, DIVORCIADO, VIUVO, UNIAO_ESTAVEL, DESQUITADO, NAO_INFORMADO) |
sexo | Sim | java.lang.String | Sexo (MASCULINO, FEMININO) |
idNacionalidade | Não | java.lang.Integer | Código da Nacionalidade |
idReligiao | Não | java.lang.Integer | Código da Religião |
idNecessidadeEspecial | Não | java.lang.Integer | Código da Necessidade Especial |
idCidadeNatural | Não | java.lang.Integer | Código da Cidade de Naturalidade |
idCor | Não | java.lang.Integer | Código da Cor/Raça |
status | Sim | java.lang.String | Status da Pessoa (ATIVO,INATIVO) |
idCidade | Não | java.lang.Integer | Código da Cidade de Endereço |
bairro | Não | java.lang.String | Bairro |
logradouro | Não | java.lang.String | Logradouro |
cep | Não | java.lang.String | CEP |
complemento | Não | java.lang.String | Complemento do Endereço |
localidade | Não | java.lang.String | Localidade do Endereço |
numero | Não | java.lang.String | Número da residência |
celular | Não | java.lang.String | Número do Celular |
fone | Não | java.lang.String | Número do Telefone fixo |
fax | Não | java.lang.String | Número do FAX |
foneComercial | Não | java.lang.String | Número do Telefone Comercial |
Não | java.lang.String | ||
observacao | Não | java.lang.String | Observações sobre o cadastro ou registro da pessoa |
idProfissao | Não | java.lang.Integer | Código da Profissão |
cargo | Não | java.lang.String | Descrição do cargo exercido |
Não | java.lang.String | URL do perfil do Facebook | |
googlePlus | Não | java.lang.String | URL do perfil do Google+ |
Não | java.lang.String | URL do perfil do Linkedin | |
Não | java.lang.String | URL do perfil do Twitter | |
lattes | Não | java.lang.String | URL do perfil da Plataforma Lattes |
http://187.60.217.18:8080/academico/api/v1/basicos/perfil/fisicos/inserir/
{ "idPerfil (Integer)": null, "nome (String)": null, "nomeImpressao (String)": null, "idCliente (Integer)": null, "tipoPessoa (String)": null, "habilidadeMotora (String)": null, "cpf (String)": null, "rg (String)": null, "rgOrgaoExpedidor (String)": null, "rgDataEmissao (Date)": null, "rne (String)": null, "cnpj (String)": null, "inscricaoEstadual (String)": null, "representanteLegal (String)": null, "inscricaoMunicipal (String)": null, "pai (String)": null, "mae (String)": null, "cpfPai (String)": null, "cpfMae (String)": null, "dataNascimento (Date)": null, "dependentes (Integer)": null, "_dataNascimento (Date)": null, "estadoCivil (String)": null, "sexo (String)": null, "foto (String)": null, "email (String)": null, "idNacionalidade (Integer)": null, "_nascionalidade (String)": null, "idReligiao (Integer)": null, "_religiao (String)": null, "idIdiomaNativo (Integer)": null, "_idiomaNativo (String)": null, "idNecessidadeEspecial (Integer)": null, "_necessidadeEspecial (String)": null, "_necessidadeEspecialCodigoInep (Integer)": null, "idCidadeNatural (Integer)": null, "_naturalidade (String)": null, "_naturalidadeUf (String)": null, "_codigoIbge (String)": null, "idCor (Integer)": null, "_cor (String)": null, "status (String)": null, "senha (String)": null, "login (String)": null, "idCidade (Integer)": null, "bairro (String)": null, "logradouro (String)": null, "cep (String)": null, "complemento (String)": null, "localidade (String)": null, "numero (String)": null, "_cidade (String)": null, "_estado (String)": null, "_uf (String)": null, "_codInepCidade (Integer)": null, "celular (String)": null, "fone (String)": null, "fax (String)": null, "foneComercial (String)": null, "_idEstado (Integer)": null, "tituloNumero (String)": null, "tituloZona (String)": null, "tituloSecao (String)": null, "tituloDataExpedicao (Date)": null, "idMunicipioTitulo (Integer)": null, "descMunicipioTitulo (String)": null, "certidaoNumero (String)": null, "certidaoFolha (String)": null, "certidaoLivro (String)": null, "certidaoCartorio (String)": null, "certidaoDataEmissao (Date)": null, "certidaoUf (String)": null, "certidaoMatricula (String)": null, "carteiraNumero (String)": null, "carteiraSerie (String)": null, "carteiraDataExpedicao (Date)": null, "carteiraUf (String)": null, "numeroPis (String)": null, "reservistaRa (String)": null, "reservistaCategoria (String)": null, "reservistaData (Date)": null, "reservistaOrgaoExpedidor (String)": null, "certidaoCasLivroDeRegistro (String)": null, "certidaoCasNumeroRegistroCas (String)": null, "certidaoCasDataCasamento (Date)": null, "certidaoCasNomeConjuge (String)": null, "certidaoCasNomeJuiz (String)": null, "observacao (String)": null, "idProfissao (Integer)": null, "idEmpresa (Integer)": null, "cargo (String)": null, "_profissao (String)": null, "_empresa (String)": null, "renda (Double)": null, "localDeTrabalho (String)": null, "tipoDeProfissao (String)": null, "nomeBanco (String)": null, "numeroBanco (String)": null, "agencia (String)": null, "conta (String)": null, "favorecido (String)": null, "isSelected (Integer)": null, "idPerfilUnificado (Integer)": null, "idioma (String)": null, "_confirmacaoSenha (String)": null, "_senhaAnterior (String)": null, "desejaReceberInformacoes (Integer)": null, "naoReceberMensagemSms (Integer)": null, "alterarSenha (Integer)": null, "tipoLocalidade (Integer)": null, "emailOrg (Integer)": null, "cursosIngresso (ArrayList)": [], "id_org (Integer)": null }
Lista todos os perfis de pessoas físicas cadastrados na instituição.
Método: POST
Resposta: JSON/XML
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
token | Sim | java.lang.String | Token do usuário |
format | Sim | java.lang.String | Formato do retorno (JSON/XML) |
tipo | Sim | java.lang.String |
Tipo do resultado da busca: -BASICA: somente os dados básicos do perfil; -COMPLETA:todos os dados do perfil; |
idPerfil | Não | java.lang.Integer | Código do Perfil |
dataAlteracaoInicio | Não | java.sql.Date | Data início de alteração da inscrição do perfil (DD/MM/YYYY) |
dataAlteracaoFim | Não | java.sql.Date | Data final de alteração da inscrição do perfil (DD/MM/YYYY) |
filtrarPor | Não | java.lang.String | Flag do campo de referência para a consulta (CPF, RNE, NOME ou EMAIL) |
termo | Não | java.lang.String | Conteúdo para a busca |
offset | Sim | java.lang.Integer | Número de registros a serem pulados na realização da consulta (paginação) |
http://187.60.217.18:8080/academico/api/v1/basicos/perfil/fisicos/
{ "idPerfil (Integer)": null, "nome (String)": null, "nomeImpressao (String)": null, "idCliente (Integer)": null, "tipoPessoa (String)": null, "habilidadeMotora (String)": null, "cpf (String)": null, "rg (String)": null, "rgOrgaoExpedidor (String)": null, "rgDataEmissao (Date)": null, "rne (String)": null, "cnpj (String)": null, "inscricaoEstadual (String)": null, "representanteLegal (String)": null, "inscricaoMunicipal (String)": null, "pai (String)": null, "mae (String)": null, "cpfPai (String)": null, "cpfMae (String)": null, "dataNascimento (Date)": null, "dependentes (Integer)": null, "_dataNascimento (Date)": null, "estadoCivil (String)": null, "sexo (String)": null, "foto (String)": null, "email (String)": null, "idNacionalidade (Integer)": null, "_nascionalidade (String)": null, "idReligiao (Integer)": null, "_religiao (String)": null, "idIdiomaNativo (Integer)": null, "_idiomaNativo (String)": null, "idNecessidadeEspecial (Integer)": null, "_necessidadeEspecial (String)": null, "_necessidadeEspecialCodigoInep (Integer)": null, "idCidadeNatural (Integer)": null, "_naturalidade (String)": null, "_naturalidadeUf (String)": null, "_codigoIbge (String)": null, "idCor (Integer)": null, "_cor (String)": null, "status (String)": null, "senha (String)": null, "login (String)": null, "idCidade (Integer)": null, "bairro (String)": null, "logradouro (String)": null, "cep (String)": null, "complemento (String)": null, "localidade (String)": null, "numero (String)": null, "_cidade (String)": null, "_estado (String)": null, "_uf (String)": null, "_codInepCidade (Integer)": null, "celular (String)": null, "fone (String)": null, "fax (String)": null, "foneComercial (String)": null, "_idEstado (Integer)": null, "tituloNumero (String)": null, "tituloZona (String)": null, "tituloSecao (String)": null, "tituloDataExpedicao (Date)": null, "idMunicipioTitulo (Integer)": null, "descMunicipioTitulo (String)": null, "certidaoNumero (String)": null, "certidaoFolha (String)": null, "certidaoLivro (String)": null, "certidaoCartorio (String)": null, "certidaoDataEmissao (Date)": null, "certidaoUf (String)": null, "certidaoMatricula (String)": null, "carteiraNumero (String)": null, "carteiraSerie (String)": null, "carteiraDataExpedicao (Date)": null, "carteiraUf (String)": null, "numeroPis (String)": null, "reservistaRa (String)": null, "reservistaCategoria (String)": null, "reservistaData (Date)": null, "reservistaOrgaoExpedidor (String)": null, "certidaoCasLivroDeRegistro (String)": null, "certidaoCasNumeroRegistroCas (String)": null, "certidaoCasDataCasamento (Date)": null, "certidaoCasNomeConjuge (String)": null, "certidaoCasNomeJuiz (String)": null, "observacao (String)": null, "idProfissao (Integer)": null, "idEmpresa (Integer)": null, "cargo (String)": null, "_profissao (String)": null, "_empresa (String)": null, "renda (Double)": null, "localDeTrabalho (String)": null, "tipoDeProfissao (String)": null, "nomeBanco (String)": null, "numeroBanco (String)": null, "agencia (String)": null, "conta (String)": null, "favorecido (String)": null, "isSelected (Integer)": null, "idPerfilUnificado (Integer)": null, "idioma (String)": null, "_confirmacaoSenha (String)": null, "_senhaAnterior (String)": null, "desejaReceberInformacoes (Integer)": null, "naoReceberMensagemSms (Integer)": null, "alterarSenha (Integer)": null, "tipoLocalidade (Integer)": null, "emailOrg (Integer)": null, "cursosIngresso (ArrayList)": [], "id_org (Integer)": null }
Lista todos os perfis de pessoas jurídicas cadastrados na instituição.
Método: POST
Resposta: JSON/XML
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
token | Sim | java.lang.String | Token do usuário |
format | Sim | java.lang.String | Formato do retorno (JSON/XML) |
tipo | Sim | java.lang.String |
Tipo do resultado da busca: -BASICA: somente os dados básicos do perfil; -COMPLETA:todos os dados do perfil; |
idPerfil | Não | java.lang.Integer | Código do Perfil |
dataAlteracaoInicio | Não | java.sql.Date | Data início de alteração da inscrição do perfil (DD/MM/YYYY) |
dataAlteracaoFim | Não | java.sql.Date | Data final de alteração da inscrição do perfil (DD/MM/YYYY) |
filtrarPor | Não | java.lang.String | Flag do campo de referência para a consulta (CNPJ, NOME, NOME_IMPRESSAO ou EMAIL) |
termo | Não | java.lang.String | Conteúdo para a busca |
offset | Sim | java.lang.Integer | Número de registros a serem pulados na realização da consulta (paginação) |
http://187.60.217.18:8080/academico/api/v1/basicos/perfil/juridicos/
{ "idPerfil (Integer)": null, "nome (String)": null, "nomeImpressao (String)": null, "idCliente (Integer)": null, "tipoPessoa (String)": null, "habilidadeMotora (String)": null, "cpf (String)": null, "rg (String)": null, "rgOrgaoExpedidor (String)": null, "rgDataEmissao (Date)": null, "rne (String)": null, "cnpj (String)": null, "inscricaoEstadual (String)": null, "representanteLegal (String)": null, "inscricaoMunicipal (String)": null, "pai (String)": null, "mae (String)": null, "cpfPai (String)": null, "cpfMae (String)": null, "dataNascimento (Date)": null, "dependentes (Integer)": null, "_dataNascimento (Date)": null, "estadoCivil (String)": null, "sexo (String)": null, "foto (String)": null, "email (String)": null, "idNacionalidade (Integer)": null, "_nascionalidade (String)": null, "idReligiao (Integer)": null, "_religiao (String)": null, "idIdiomaNativo (Integer)": null, "_idiomaNativo (String)": null, "idNecessidadeEspecial (Integer)": null, "_necessidadeEspecial (String)": null, "_necessidadeEspecialCodigoInep (Integer)": null, "idCidadeNatural (Integer)": null, "_naturalidade (String)": null, "_naturalidadeUf (String)": null, "_codigoIbge (String)": null, "idCor (Integer)": null, "_cor (String)": null, "status (String)": null, "senha (String)": null, "login (String)": null, "idCidade (Integer)": null, "bairro (String)": null, "logradouro (String)": null, "cep (String)": null, "complemento (String)": null, "localidade (String)": null, "numero (String)": null, "_cidade (String)": null, "_estado (String)": null, "_uf (String)": null, "_codInepCidade (Integer)": null, "celular (String)": null, "fone (String)": null, "fax (String)": null, "foneComercial (String)": null, "_idEstado (Integer)": null, "tituloNumero (String)": null, "tituloZona (String)": null, "tituloSecao (String)": null, "tituloDataExpedicao (Date)": null, "idMunicipioTitulo (Integer)": null, "descMunicipioTitulo (String)": null, "certidaoNumero (String)": null, "certidaoFolha (String)": null, "certidaoLivro (String)": null, "certidaoCartorio (String)": null, "certidaoDataEmissao (Date)": null, "certidaoUf (String)": null, "certidaoMatricula (String)": null, "carteiraNumero (String)": null, "carteiraSerie (String)": null, "carteiraDataExpedicao (Date)": null, "carteiraUf (String)": null, "numeroPis (String)": null, "reservistaRa (String)": null, "reservistaCategoria (String)": null, "reservistaData (Date)": null, "reservistaOrgaoExpedidor (String)": null, "certidaoCasLivroDeRegistro (String)": null, "certidaoCasNumeroRegistroCas (String)": null, "certidaoCasDataCasamento (Date)": null, "certidaoCasNomeConjuge (String)": null, "certidaoCasNomeJuiz (String)": null, "observacao (String)": null, "idProfissao (Integer)": null, "idEmpresa (Integer)": null, "cargo (String)": null, "_profissao (String)": null, "_empresa (String)": null, "renda (Double)": null, "localDeTrabalho (String)": null, "tipoDeProfissao (String)": null, "nomeBanco (String)": null, "numeroBanco (String)": null, "agencia (String)": null, "conta (String)": null, "favorecido (String)": null, "isSelected (Integer)": null, "idPerfilUnificado (Integer)": null, "idioma (String)": null, "_confirmacaoSenha (String)": null, "_senhaAnterior (String)": null, "desejaReceberInformacoes (Integer)": null, "naoReceberMensagemSms (Integer)": null, "alterarSenha (Integer)": null, "tipoLocalidade (Integer)": null, "emailOrg (Integer)": null, "cursosIngresso (ArrayList)": [], "id_org (Integer)": null }