API de Integração - Documentação | Sistema Acadêmico SWA.JACAD

Descrição:
Esse método irá gerar uma nova inscrição no sistema com base nos parâmetros informados.

Verbo:
POST

Resposta:
JSON/XML

URIs de Acesso:

https://icj.jacad.com.br:443/academico/api/v3/vestibular/inscricoes/cadastrar

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)
dadosInscricao	Sim	jacad.persistencia.tables.api.InscricaoApiForm	Dados da Inscrição

{
  "classificacao (Integer)": null,
  "idEdital (Integer)": null,
  "idUnidadeFisica (Integer)": null,
  "nome (String)": null,
  "email (String)": null,
  "sexo (String)": null,
  "estadoCivil (String)": null,
  "fone (String)": null,
  "celular (String)": null,
  "foneComercial (String)": null,
  "rg (String)": null,
  "cpf (String)": null,
  "rne (String)": null,
  "senha (String)": null,
  "confirmacaoSenha (String)": null,
  "resumoProfissional (String)": null,
  "idCor (Integer)": null,
  "dataNascimento (Date)": null,
  "idNecessidadeEspecial (Integer)": null,
  "idCidade (Integer)": null,
  "bairro (String)": null,
  "logradouro (String)": null,
  "numero (String)": null,
  "cep (String)": null,
  "idLocalProva (Integer)": null,
  "idEditalSala (Integer)": null,
  "idEstado (Integer)": null,
  "obsNecessidadeEspecial (String)": null,
  "outrasIndicacoes (String)": null,
  "alunoIndicou (String)": null,
  "empresaIndicou (String)": null,
  "observacao (String)": null,
  "idFormaConhecimento (Integer)": null,
  "idEditalCurso1 (Integer)": null,
  "idEditalCurso2 (Integer)": null,
  "situacao (String)": null,
  "linguaEstrangeira (String)": null,
  "idSituacaoEnsinoMedio (Integer)": null,
  "desejaReceberInformacoes (Integer)": null,
  "anoConclusaoEnsinoMedio (Integer)": null,
  "procedenciaEscolaPublica (String)": null,
  "situacaoEnsinoSuperior (String)": null,
  "idMetodoRecebimento (Integer)": null,
  "idColegio (Integer)": null,
  "isEstrangeiro (boolean)": false,
  "descricaoItemTransacao (String)": null,
  "utilizarNotaEnemComoAvaliacao (Integer)": null,
  "idReligiao (Integer)": null,
  "enemNota (Double)": null,
  "enemAno (Integer)": null,
  "enemInscricao (String)": null,
  "idVendedor (Integer)": null,
  "diplomadoInstituicao (String)": null,
  "diplomadoCurso (String)": null,
  "diplomadoData (Date)": null,
  "transferenciaExternaInstituicao (String)": null,
  "transferenciaExternaCurso (String)": null,
  "dataProva (Date)": null,
  "horaInicio (Time)": null,
  "horaTermino (Time)": null,
  "idDataProva (Integer)": null,
  "lateralidade (String)": null,
  "idTipoAtendimento (Integer)": null,
  "idAtendimentoOrigem (Integer)": null,
  "formaIngresso (String)": null,
  "possuiNecessidadeEspecial (Integer)": null,
  "idEstadoPolo (Integer)": null,
  "nomeResponsavel (String)": null,
  "cpfResponsavel (String)": null,
  "dataNascimentoResponsavel (Date)": null,
  "idCidadeResponsavel (Integer)": null,
  "logradouroResponsavel (String)": null,
  "bairroResponsavel (String)": null,
  "numeroResponsavel (String)": null,
  "cepResponsavel (String)": null,
  "sexoResponsavel (String)": null
}

{
  "idOrg (Integer)": null,
  "organizacao (String)": null,
  "idEdital (Integer)": null,
  "descricao (String)": null,
  "idPerfil (Integer)": null,
  "idCurso1 (Integer)": null,
  "curso1UnidadeFisica (String)": null,
  "idCurso2 (Integer)": null,
  "curso2UnidadeFisica (String)": null,
  "idPerfilResponsavel (Integer)": null,
  "nomeResponsavel (String)": null,
  "cpfResponsavel (String)": null,
  "emailResponsavel (String)": null,
  "idUnidadeFisica (Integer)": null,
  "idNecessidadeEspecial (Integer)": null,
  "idAluno (Integer)": null,
  "alunoIndicou (String)": null,
  "anoConclusaoEnsinoMedio (Integer)": null,
  "bairro (String)": null,
  "celular (String)": null,
  "cep (String)": null,
  "chamadaInscricaoCurso1 (Integer)": null,
  "chamadaInscricaoCurso2 (Integer)": null,
  "classificacao (Integer)": null,
  "classificacaoChamadaCurso (String)": null,
  "cpf (String)": null,
  "dataAlteracao (Timestamp)": null,
  "dataNascimento (Date)": null,
  "dataProva (Date)": null,
  "dataInscricao (Timestamp)": null,
  "descSituacao (String)": null,
  "desempate (Integer)": null,
  "diplomadoCurso (String)": null,
  "diplomadoData (Date)": null,
  "diplomadoInstituicao (String)": null,
  "email (String)": null,
  "empresaIndicou (String)": null,
  "enemAno (Integer)": null,
  "enemInscricao (String)": null,
  "enemNota (Double)": null,
  "ensinoMedio (String)": null,
  "estadoCivil (String)": null,
  "fone (String)": null,
  "foneComercial (String)": null,
  "formaIngresso (String)": null,
  "formaPagamento (String)": null,
  "horaInicio (Time)": null,
  "horaTermino (Time)": null,
  "idInscricao (Integer)": null,
  "isento (Integer)": null,
  "lingua_estrangeira (String)": null,
  "logradouro (String)": null,
  "motivoIsencao (String)": null,
  "nome (String)": null,
  "notaFinal (Double)": null,
  "obsNecessidadeEspecial (String)": null,
  "observacao (String)": null,
  "origemInscricao (String)": null,
  "outrasIndicacoes (String)": null,
  "possuiNecessidadeEspecial (Integer)": null,
  "presente (Integer)": null,
  "prestouEnem (Integer)": null,
  "procedenciaEscolaPublica (String)": null,
  "rg (String)": null,
  "senha (String)": null,
  "sexo (String)": null,
  "situacao (String)": null,
  "situacaoEnsinoSuperior (String)": null,
  "statusInscricaoCurso1 (String)": null,
  "statusInscricaoCurso2 (String)": null,
  "transferenciaExterna (String)": null,
  "transferenciaExternaCurso (String)": null,
  "transferenciaExternaInstituicao (String)": null,
  "utilizarNotaEnemComoAvaliacao (Integer)": null,
  "valor (Double)": null,
  "idTipoProcessoSeletivo (Integer)": null
}

Descrição:
Lista todas as avaliações dos editais da instituição.

Verbo:
POST

Resposta:
JSON/XML

URIs de Acesso:

https://icj.jacad.com.br:443/academico/api/v3/vestibular/avaliacoes-edital

Parâmetro	Obrigatório	Tipo	Descrição
idEdital	Sim	java.lang.Integer	Código do edital
token	Sim	java.lang.String	Token do usuário
format	Sim	java.lang.String	Formato do retorno (JSON/XML)

{
  "idAvaliacaoVestibular (Integer)": null,
  "idEdital (Integer)": null,
  "identificacao (String)": null,
  "notaMinimaAprovacao (Double)": null
}

Descrição:
Lista todas as configurações do vestibular da instituição.

Verbo:
POST

Resposta:
JSON/XML

URIs de Acesso:

https://icj.jacad.com.br:443/academico/api/v3/vestibular/configuracoes

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)
idEdital	Sim	java.lang.Integer	Código do edital

{
  "idOrg (Integer)": null,
  "idEdital (Integer)": null,
  "idConfiguracaoVestibular (Integer)": null,
  "campoEstadoCivil (String)": null,
  "campoFoneComercial (String)": null,
  "campoFoneResidencial (String)": null,
  "campoFoneCelular (String)": null,
  "campoEnsinoMedio (String)": null,
  "campoLinguaEstrangeira (String)": null,
  "campoCidade (String)": null,
  "campoBairro (String)": null,
  "campoLogradouro (String)": null,
  "campoNumero (String)": null,
  "campoCep (String)": null,
  "campoFormaConhecimento (String)": null,
  "campoResumoProfissional (String)": null,
  "campoCorRaca (String)": null,
  "comprovanteApresentarEnsalamento (String)": null,
  "desejaReceberInformacoes (String)": null,
  "blocoIndicacoes (String)": null,
  "campoAnoConclusaoEnsinoMedio (String)": null,
  "campoProcedenciaEscolaPublica (String)": null,
  "campoReligiao (String)": null,
  "campoSituacaoEnsinoSuperior (String)": null,
  "senhaPadraoNovoPerfil (String)": null,
  "urlVestibular (String)": null,
  "formatacaoNome (String)": null,
  "campoLateralidade (String)": null,
  "campoAtendimentoDiferenciado (String)": null,
  "campoNumeroInscricaoEnem (String)": null,
  "descricao (String)": null,
  "situacao (String)": null,
  "mostrarAlertaInconsistencias (Integer)": null,
  "enviarEmailAutomaticamente (Integer)": null,
  "idTemplateEmailRecuperacaoSenha (Integer)": null,
  "idTemplateEmailAprovacaoVestibular (Integer)": null,
  "obrigatorioDadosResponsavelInscritoMenorIdade (Integer)": null,
  "formaIngressoVestibular (Integer)": null,
  "formaIngressoEnem (Integer)": null,
  "formaIngressoDiplomado (Integer)": null,
  "formaIngressoTransferencia (Integer)": null,
  "idFormaIngressoVestibular (Integer)": null,
  "idFormaIngressoEnem (Integer)": null,
  "idFormaIngressoDiplomado (Integer)": null,
  "idFormaIngressoTransferencia (Integer)": null,
  "apresentarLocalProvaNotaEnem (Integer)": null
}

Descrição:
Lista todos os Cursos ofertados nos editais da instituição.

Verbo:
POST

Resposta:
JSON/XML

URIs de Acesso:

https://icj.jacad.com.br:443/academico/api/v3/vestibular/cursos

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
idEdital	Não	java.lang.Integer	Código do Edital
offset	Sim	java.lang.Integer	Número de registros a serem pulados na realização da consulta (paginação)

{
  "idEditalCurso (Integer)": null,
  "idEdital (Integer)": null,
  "idOrg (Integer)": null,
  "organizacao (String)": null,
  "cursoMatriz (String)": null,
  "cursoBase (String)": null,
  "status (String)": null,
  "turno (String)": null,
  "numeroVagas (Integer)": null,
  "chamadaAtual (Integer)": null,
  "metaInscritos (Integer)": null,
  "metaMatriculas (Integer)": null,
  "inserirSegundaOpcaoCursoListaClassificacaoCurso (Integer)": null
}

Descrição:
Lista todos os Editais disponíveis na instituição.

Verbo:
POST

Resposta:
JSON/XML

URIs de Acesso:

https://icj.jacad.com.br:443/academico/api/v3/vestibular/editais

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	Sim	java.lang.Integer	Código da instituição
statusEdital	Não	java.lang.String	Status (ABERTO, CONCLUIDO, CANCELADO, AGUARDANDO)
idPeriodoLetivo	Não	java.lang.Integer	Código do período letivo
idEdital	Não	java.lang.Integer	Código do edital
offset	Sim	java.lang.Integer	Número de registros a serem pulados na realização da consulta (paginação)

{
  "idOrg (Integer)": null,
  "organizacao (String)": null,
  "idPeriodoLetivo (Integer)": null,
  "periodoLetivo (String)": null,
  "idEdital (Integer)": null,
  "descricao (String)": null,
  "formulaNota (String)": null,
  "statusEdital (String)": null,
  "dataInicio (Date)": null,
  "dataTermino (Date)": null,
  "dataVencimentoBoleto (Date)": null,
  "meioPagamento (String)": null,
  "utilizarVencimentoDinamicoBoleto (Integer)": null,
  "diasVencimentoDinamicoBoleto (Integer)": null,
  "mediaAprovacao (Double)": null,
  "valorBoleto (Double)": null,
  "vencimentoBoletoAntesProva (Integer)": null,
  "umaOpcaoCursoVestibular (Integer)": null,
  "instrucoes (String)": null,
  "instrucoesPosInscricao (String)": null,
  "instrucoesParaChamadas (String)": null,
  "arquivoManualCandidato (String)": null,
  "arquivoEditalVestibular (String)": null,
  "tipoEnsalamento (String)": null,
  "tipoLogin (String)": null,
  "dataLimiteVisualizacao (Date)": null,
  "mostrarSituacaoInscricao (Integer)": null,
  "mostrarNota (Integer)": null,
  "mostrarClassificacao (Integer)": null,
  "periodoInscricaoEncerrado (Integer)": null,
  "tipoEdital (String)": null,
  "descricaoTemTransacao (String)": null,
  "inserirSegundaOpcaoCursoListaClassificacaoCurso (Integer)": null,
  "apresentarListaDeChamadasNoPortal (Integer)": null,
  "modalidadeEdital (String)": null,
  "tipoClassificacaoCadastroAluno (String)": null,
  "permitirMatriculaOnline (Integer)": null,
  "idTipoProcessoSeletivo (Integer)": null,
  "instrucoesParaMatriculaOnline (String)": null,
  "instrucoesParaDepoisMatriculaOnline (String)": null,
  "apresentarNotaNoPortal (Integer)": null,
  "habilitarRenovacaoBoletosNoPortal (Integer)": null,
  "permitirAlterarDataProvaInscricao (Integer)": null,
  "instrucoesProva (String)": null,
  "periodoProvasDataInicio (Date)": null,
  "periodoProvasDataTermino (Date)": null,
  "formularioHtml (String)": null,
  "naoAdicionarEncargosParcela (Integer)": null,
  "isentarFormaIngressoVestibular (Integer)": null,
  "isentarFormaIngressoEnem (Integer)": null,
  "isentarFormaIngressoDiplomado (Integer)": null,
  "isentarFormaIngressoTransferencia (Integer)": null,
  "notaMinimaAprovacaoEnem (Double)": null,
  "enemAceitarNotaMinimaMenor (Integer)": null,
  "anoEnemInicio (Integer)": null,
  "anoEnemFim (Integer)": null,
  "habilitarIntegracaoAvalia (Integer)": null,
  "integracaoAvaliaCodigoProcessoSeletivo (String)": null
}

Descrição:
Lista todos os candidatos inscritos nos editais da instituição.

Verbo:
POST

Resposta:
JSON/XML

URIs de Acesso:

https://icj.jacad.com.br:443/academico/api/v3/vestibular/inscricoes

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	Sim	java.lang.Integer	Código da instituição
idEdital	Sim	java.lang.Integer	Código do edital
idPerfil	Não	java.lang.Integer	Código do perfil
idInscricao	Não	java.lang.Integer	Código da inscrição
descSituacao	Não	java.lang.String	Status (INSCRITO, APROVADO, REPROVADO, AUSENTE)
dataInscricaoInicio	Não	java.sql.Date	Data inscrição início
dataInscricaoFim	Não	java.sql.Date	Data inscrição fim
isSomenteComMatricula	Não	boolean	Somente inscrições associadas a uma matrícula
isSomenteComAluno	Não	boolean	Somente inscrições associadas a um aluno
like	Não	java.lang.String	Like sobre o campo 'nome', 'cpf', 'email'
offset	Sim	java.lang.Integer	Número de registros a serem pulados na realização da consulta (paginação)

{
  "idOrg (Integer)": null,
  "organizacao (String)": null,
  "idEdital (Integer)": null,
  "descricao (String)": null,
  "idPerfil (Integer)": null,
  "idCurso1 (Integer)": null,
  "curso1UnidadeFisica (String)": null,
  "idCurso2 (Integer)": null,
  "curso2UnidadeFisica (String)": null,
  "idPerfilResponsavel (Integer)": null,
  "nomeResponsavel (String)": null,
  "cpfResponsavel (String)": null,
  "emailResponsavel (String)": null,
  "idUnidadeFisica (Integer)": null,
  "idNecessidadeEspecial (Integer)": null,
  "idAluno (Integer)": null,
  "alunoIndicou (String)": null,
  "anoConclusaoEnsinoMedio (Integer)": null,
  "bairro (String)": null,
  "celular (String)": null,
  "cep (String)": null,
  "chamadaInscricaoCurso1 (Integer)": null,
  "chamadaInscricaoCurso2 (Integer)": null,
  "classificacao (Integer)": null,
  "classificacaoChamadaCurso (String)": null,
  "cpf (String)": null,
  "dataAlteracao (Timestamp)": null,
  "dataNascimento (Date)": null,
  "dataProva (Date)": null,
  "dataInscricao (Timestamp)": null,
  "descSituacao (String)": null,
  "desempate (Integer)": null,
  "diplomadoCurso (String)": null,
  "diplomadoData (Date)": null,
  "diplomadoInstituicao (String)": null,
  "email (String)": null,
  "empresaIndicou (String)": null,
  "enemAno (Integer)": null,
  "enemInscricao (String)": null,
  "enemNota (Double)": null,
  "ensinoMedio (String)": null,
  "estadoCivil (String)": null,
  "fone (String)": null,
  "foneComercial (String)": null,
  "formaIngresso (String)": null,
  "formaPagamento (String)": null,
  "horaInicio (Time)": null,
  "horaTermino (Time)": null,
  "idInscricao (Integer)": null,
  "isento (Integer)": null,
  "lingua_estrangeira (String)": null,
  "logradouro (String)": null,
  "motivoIsencao (String)": null,
  "nome (String)": null,
  "notaFinal (Double)": null,
  "obsNecessidadeEspecial (String)": null,
  "observacao (String)": null,
  "origemInscricao (String)": null,
  "outrasIndicacoes (String)": null,
  "possuiNecessidadeEspecial (Integer)": null,
  "presente (Integer)": null,
  "prestouEnem (Integer)": null,
  "procedenciaEscolaPublica (String)": null,
  "rg (String)": null,
  "senha (String)": null,
  "sexo (String)": null,
  "situacao (String)": null,
  "situacaoEnsinoSuperior (String)": null,
  "statusInscricaoCurso1 (String)": null,
  "statusInscricaoCurso2 (String)": null,
  "transferenciaExterna (String)": null,
  "transferenciaExternaCurso (String)": null,
  "transferenciaExternaInstituicao (String)": null,
  "utilizarNotaEnemComoAvaliacao (Integer)": null,
  "valor (Double)": null,
  "idTipoProcessoSeletivo (Integer)": null
}

Descrição:
Lista todos os locais de prova dos editais da instituição.

Verbo:
POST

Resposta:
JSON/XML

URIs de Acesso:

https://icj.jacad.com.br:443/academico/api/v3/vestibular/locais-de-prova

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
idEdital	Sim	java.lang.Integer	Código do edital
idUnidadeFisica	Não	java.lang.Integer	Código da unidade física
offset	Sim	java.lang.Integer	Número de registros a serem pulados na realização da consulta (paginação)

{
  "idOrg (Integer)": null,
  "idLocalProva (Integer)": null,
  "idInstituicao (Integer)": null,
  "instituicao (String)": null,
  "idEdital (Integer)": null,
  "dataProva (Date)": null,
  "horaInicio (Time)": null,
  "horaTermino (Time)": null,
  "status (String)": null,
  "cidade (String)": null,
  "estado (String)": null,
  "logradouro (String)": null,
  "numero (String)": null,
  "bairro (String)": null,
  "CEP (String)": null,
  "localProva (String)": "",
  "quantidadeInscritos (Integer)": null,
  "quantidadeVagasRestantes (Integer)": null,
  "quantidadeVagasTotal (Integer)": null,
  "idUnidadeFisica (Integer)": null,
  "unidadeFisica (String)": null,
  "siglaUnidadeFisica (String)": null,
  "cidadeUnidadeFisica (String)": null,
  "ufUnidadeFisica (String)": null,
  "dataProvaFormatada (String)": null,
  "horaInicioFormatada (String)": null,
  "horaTerminoFormatada (String)": null,
  "possuiSalaParaAlunosComNecessidadesEspeciais (Integer)": null,
  "possuiSalaSomenteParaAlunosComNecessidadesEspeciais (Integer)": null
}

Descrição:
Lista todas as salas dos locais de prova dos editais da instituição.

Verbo:
POST

Resposta:
JSON/XML

URIs de Acesso:

https://icj.jacad.com.br:443/academico/api/v3/vestibular/salas

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
idEdital	Sim	java.lang.Integer	Código do edital
idLocalProva	Não	java.lang.Integer	Código do local de prova
somenteParaAlunosComNecessidadeEspeciais	Não	boolean	Flag do campo de referência para a consulta (Possui sala para portadores de necessidades especiais)
offset	Sim	java.lang.Integer	Número de registros a serem pulados na realização da consulta (paginação)

{
  "idLocalProva (Integer)": null,
  "idEdital (Integer)": null,
  "idOrg (Integer)": null,
  "idEditalSala (Integer)": null,
  "ordem (Integer)": null,
  "idSala (Integer)": null,
  "sala (String)": null,
  "capacidade (Integer)": null,
  "bloco (String)": null,
  "somenteParaAlunosComNecessidadeEspeciais (Integer)": null
}

Descrição:
Realiza o processamento/lançamento da nota final da inscrição informada.

Verbo:
POST

Resposta:
JSON/XML

URIs de Acesso:

https://icj.jacad.com.br:443/academico/api/v3/vestibular/lancar-nota

Parâmetro	Obrigatório	Tipo	Descrição
idInscricao	Sim	java.lang.Integer	Código da inscricao
notaFinal	Sim	java.lang.Double	Nota Final (Média)
token	Sim	java.lang.String	Token do usuário
format	Sim	java.lang.String	Formato do retorno (JSON/XML)

""