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

Atendimento - Criar conta a receber

Cria um conta receber referente a um serviço do atendimento
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)
idServico	Sim	java.lang.Integer	Código Serviço
dataVencimento	Sim	java.sql.Date	Data de vencimento primeira parcela
valor	Sim	java.lang.Double	Valor da parcela
dataCompetencia	Não	java.sql.Date	Data de competência
numeroParcelas	Não	java.lang.Integer	Número de parcelas
idMetodoRecebimento	Sim	java.lang.Integer	Código do mótodo de recebimento
idPagador	Sim	java.lang.Integer	Código do Pagador

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/atendimentos/gerar-transacao/

Formato do objeto de retorno

{
  "idTransacao (Integer)": null,
  "consolidado (Integer)": null,
  "status (String)": null,
  "situacao (String)": null,
  "origem (String)": null,
  "idPagador (Integer)": null,
  "tipoPagador (String)": null,
  "index1 (Integer)": null,
  "idResponsavel (Integer)": null,
  "idReferencia (Integer)": null,
  "tipoReferencia (String)": null,
  "idAcordoFinanceiro (Integer)": null,
  "idAcordoFinanceiroCancelamento (Integer)": null,
  "dataCancelamento (Date)": null,
  "dataEmissao (Date)": null,
  "dataVencimento (Date)": null,
  "dataCompetencia (Date)": null,
  "dataPrevisaoPagamento (Date)": null,
  "idUsuarioCancelamento (Integer)": null,
  "_usuarioCancelamento (String)": null,
  "valor (Double)": null,
  "valorOriginal (Double)": null,
  "dataPagamento (Date)": null,
  "valorPago (Double)": null,
  "valorPagoReal (Double)": null,
  "valorAPagar (Double)": null,
  "valorEncargos (Double)": null,
  "valorDescontos (Double)": null,
  "totalPago (Double)": null,
  "valorDevedor (Double)": null,
  "valorBaixa (Double)": null,
  "dataSpcSerasa (Date)": null,
  "dataProtestado (Date)": null,
  "numeroParcela (String)": null,
  "notaFiscal (String)": null,
  "nfseStatus (String)": null,
  "nfseNumero (String)": null,
  "nfseEmissao (Timestamp)": null,
  "nfseLote (String)": null,
  "nfseRetorno (String)": null,
  "motivo (String)": null,
  "observacao (String)": null,
  "motivoCancelamento (String)": null,
  "idBoletoAtivo (Integer)": null,
  "itens (ArrayList)": [],
  "descontos (ArrayList)": [],
  "descontosPerdidos (ArrayList)": [],
  "encargos (ArrayList)": [],
  "boletos (ArrayList)": [],
  "_pagador (String)": null,
  "_responsavel (String)": null,
  "isNotaFiscal (Integer)": null,
  "isAssessoriaCobranca (Integer)": null,
  "isSCPCSerasa (Integer)": null,
  "isProtestado (Integer)": null,
  "operacao (String)": null,
  "idTransacaoReferencia (Integer)": null,
  "isPrevisto (Integer)": null,
  "descricao (String)": null,
  "dadosProcessados (Integer)": null,
  "possuiRateioPagadores (Integer)": null,
  "_descricaoOrg (String)": null,
  "idContratoParcela (Integer)": null,
  "idContrato (Integer)": null,
  "_ordemSituacao (Integer)": null,
  "_ano (Integer)": null,
  "_boletoDataVencimento (Date)": null,
  "_boletoDataRemessa (Date)": null,
  "_boletoNossoNumero (String)": null,
  "_boletoDigitoVerificador (String)": null,
  "_boletoLiberadoWeb (Integer)": null,
  "_liberacaoImpressaoWeb (Integer)": null,
  "idMotivoCancelamentoTransacao (Integer)": null,
  "_descricaoMotivoCancelamentoTransacao (String)": null,
  "_quantidadeRenovacoes (Integer)": null,
  "_nomeEmpCob (String)": null,
  "_idBoletoGateway (Integer)": null,
  "id_org (Integer)": null
}

Atendimento - Criar Atendimento

Cria um novo atendimento.
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	Sim	java.lang.Integer	Código da organizaçãoo
idCursoInteresse	Sim	java.lang.Integer	Código curso de interesse
nomeCursoInteresse	Sim	java.lang.String	Nome do Curso de interesse
idUnidadeFisica	Sim	java.lang.Integer	Código unidade fisica
idTurma	Não	java.lang.Integer	Código Turma
nome	Não	java.lang.String	Nome
cpf	Não	java.lang.String	CPF
rg	Não	java.lang.String	RG
email	Não	java.lang.String	E-Mail
sexo	Não	java.lang.String	Sexo
dataNascimento	Não	java.sql.Date	Data Nscimento
estadoCivil	Não	java.lang.String	Estado Civil
fone	Não	java.lang.String	Telefone Fixo
idCidade	Não	java.lang.Integer	Código da cidade
bairro	Não	java.lang.String	Bairro
numero	Não	java.lang.String	Número Endereço
cep	Não	java.lang.String	CEP
logradouro	Não	java.lang.String	Logradouro
codigo	Não	java.lang.String	Código referência call center
formulario	Não	java.lang.String	Formulário de origem dos dados

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/atendimentos/atendimento/

Formato do objeto de retorno

{
  "idAtendimento (Integer)": null,
  "idAtendente (Integer)": null,
  "idPerfil (Integer)": null,
  "idOrigemContato (Integer)": null,
  "idTipoPublicidade (Integer)": null,
  "idCursoInteresse (Integer)": null,
  "idCursoInteresse2 (Integer)": null,
  "idCursoInteresse3 (Integer)": null,
  "idTurma (Integer)": null,
  "idStatusAtendimento (Integer)": null,
  "idUnidadeFisica (Integer)": null,
  "dataAtendimento (Timestamp)": null,
  "dataRetornoContato (Timestamp)": null,
  "dataConclusao (Timestamp)": null,
  "observacao (String)": null,
  "identificacao (String)": null,
  "codigo (String)": null,
  "outroTipoPublicidade (String)": null,
  "atendimentoWeb (Integer)": null,
  "formulario (String)": null,
  "_atendente (String)": null,
  "_idUsuario (Integer)": null,
  "_perfil (String)": null,
  "_prospect (String)": null,
  "_origemContato (String)": null,
  "_tipoPublicidade (String)": null,
  "_cursoInteresse (String)": null,
  "_cursoInteresse2 (String)": null,
  "_cursoInteresse3 (String)": null,
  "_statusAtendimento (String)": null,
  "_corStatus (String)": null,
  "_indicadorAtendimentoFinalizado (Integer)": null,
  "_idAlunoCursoIngresso (Integer)": null,
  "_statusCursoIngresso (String)": null,
  "_statusMatricula (String)": null,
  "_turma (String)": null,
  "_idCurso (Integer)": null,
  "_idOrgCurso (Integer)": null,
  "_curso (String)": null,
  "_cidadeTurma (String)": null,
  "_estadoTurma (String)": null,
  "_idAluno (Integer)": null,
  "_email (String)": null,
  "_cpf (String)": null,
  "_fone (String)": null,
  "_celular (String)": null,
  "_cidade (String)": null,
  "_estado (String)": null,
  "_dataNascimento (Date)": null,
  "_idCursoBaseTurma (Integer)": null,
  "localGraduacao (String)": null,
  "cursoGraduacao (String)": null,
  "dataGraduacao (Date)": null,
  "notaEnem (Integer)": null,
  "_valorTransacao (Double)": null,
  "idVendedor (Integer)": null,
  "tipoPagamento (String)": null,
  "_possuiDiploma (String)": null,
  "_senha (String)": null,
  "_login (String)": null,
  "_sexo (String)": null,
  "_rg (String)": null,
  "id_org (Integer)": null
}

Atendimento - Consultar Unidade Física

Lista as Unidades Físicas 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)
idCidade	Sim	java.lang.Integer	Código da cidade
idEstado	Sim	java.lang.Integer	Código do estado

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/atendimentos/listar-polos/

Formato do objeto de retorno

{
  "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
}

Atendimento - Consultar Cidades

Lista as Unidades Físicas 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)
idEstado	Não	java.lang.Integer	Código do Estado

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/atendimentos/listar-cidade-estado/

Formato do objeto de retorno

{
  "idCidade (Integer)": null,
  "descricao (String)": null,
  "idEstado (Integer)": null,
  "codigoInep (Integer)": null,
  "uf (String)": null,
  "_estado (String)": null,
  "codigoIbge (String)": null,
  "id_org (Integer)": null
}

Atendimento - Consultar Cidades polos

Lista as Cidades do estado que possuam polos.
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)
idEstado	Não	java.lang.Integer	Código do Estado

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/atendimentos/listar-cidade-polo/

Formato do objeto de retorno

{
  "idCidade (Integer)": null,
  "descricao (String)": null,
  "idEstado (Integer)": null,
  "codigoInep (Integer)": null,
  "uf (String)": null,
  "_estado (String)": null,
  "codigoIbge (String)": null,
  "id_org (Integer)": null
}

Atendimento - Consultar Modalidades

Lista as Modadalidades (graus de graduação) associados a cursos de interesse
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)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/atendimentos/listar-modlidade/

Formato do objeto de retorno

{
  "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
}

Atendimento - Consultar Estados (UF)

Lista os Estados.
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)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/atendimentos/listar-estados/

Formato do objeto de retorno

{
  "idEstado (Integer)": null,
  "descricao (String)": null,
  "idPais (Integer)": null,
  "codigoInep (Integer)": null,
  "sigla (String)": null,
  "tratamento (String)": null,
  "id_org (Integer)": null
}

Atendimento - Consultar Curso Interesse

Lista todos os Curso Interesse 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)
idModalidade	Não	java.lang.Integer	Código da Modalidade

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/atendimentos/listar-curso-interesse/

Formato do objeto de retorno

{
  "idCursoInteresse (Integer)": null,
  "nome (String)": null,
  "status (String)": null,
  "idCursoBase (Integer)": null,
  "idCurso (Integer)": null,
  "_curso (String)": null,
  "idGrauGraduacao (Integer)": null,
  "_grauGraduacao (String)": null,
  "idTurma (Integer)": null,
  "_turma (String)": null,
  "_idPeriodoLetivo (Integer)": null,
  "_periodoLetivo (String)": null,
  "_periodoLetivoSituacao (String)": null,
  "_cursoBase (String)": null,
  "idEdital (Integer)": null,
  "gerarInscricao (Integer)": null,
  "idEditalCurso (Integer)": null,
  "id_org (Integer)": null
}