privado
180
edições
Mudanças
De UltramaxWiki
Gestão Escolar - API de integração (ver código-fonte)
Edição das 12h55min de 23 de fevereiro de 2024
, 23 fevereiro→Resposta
Método: GET
Método: GET
(base)/gestaoescolar/services/v1/cursos?codigoUnidadeEnsino=1&periodoLetivo=2022
(base)/gestaoescolar/services/v1/cursos?codigoUnidadeEnsino=100&periodoLetivo=2022
====Query String (Parâmetros)====
====Query String (Parâmetros)====
|-
|-
|nomeCurso
|nomeCurso
|Nome do curso para verificação se existe no cadastro de curso
|Texto para localizar parcialmente os registros usando a descrição da curso
|-
|-
|numeroSequenciaSerie
|numeroSequenciaSerie
Informando o código, irá retornar a série correspondente cadastrada
Informando o código, irá retornar a série correspondente cadastrada
|-
|pagina (paginação)
|Indica qual página está listando na sequência
|-
|registros (paginação)
|Quantidade de registros que devem ser retornados em cada página
|}
|}
|Tamanho
|Tamanho
|-
|-
|'''codigoUnidade'''
|id
|Identificador interno (id)
|Número
|
|-
|codigoUnidade
|Código da unidade de ensino
|Código da unidade de ensino
|Número
|Número
|
|
|-
|-
|'''periodoLeletivo'''
|periodoLetivo
|Descrição do período Letivo
|Descrição do período Letivo
|Texto
|Texto
|20
|20
|-
|-
|'''codigoCurso'''
|codigoCurso
|Código do curso
|Código do curso
|Texto
|Texto
|15
|15
|-
|-
|'''nomeCurso'''
|nomeCurso
|Nome do curso
|Nome do curso
|Texto
|Texto
|70
|70
|-
|-
|'''itemServico'''
|itemServico
|Código do item de serviço do curso
|Código do item de serviço do curso
|Texto
|Texto
|9
|9
|-
|-
|'''codigoIntegracao'''
|codigoIntegracao
|Código sku de integração entre sistemas de terceiro
|Código sku de integração entre sistemas de terceiro
|Texto
|Texto
|255
|255
|-
|-
|'''modalidadeCurso'''
|modalidadeCurso
|Modalidade do Curso (EAD, Presencial)
|Modalidade do Curso (EAD, Presencial)
|Texto
|Texto
|50
|50
|-
|-
|'''naturezaOperacao'''
|naturezaOperacao
|Natureza de operação que o curso permite
|Natureza de operação que o curso permite
|Texto
|Texto
|70
|70
|-
|-
|'''statusCurso'''
|statusCurso
|Situação do curso (ATIVO, INATIVO, TODOS)
|Situação do curso (A, I) Onde A = Ativo,I = Inativo
|Texto
|Texto
|65
|1
|}
|}
Método: GET
Método: GET
(base)/gestaoescolar/services/v1/series?codigoUnidadeEnsino=1&periodoLetivo=2022
(base)/gestaoescolar/services/v1/series?codigoUnidadeEnsino=100&periodoLetivo=2022
====Query String (Parâmetros)====
====Query String (Parâmetros)====
|Campo
|Campo
|Descrição
|Descrição
|
|-
|-
|Sim
|Sim
|codigoUnidadeEnsino
|codigoUnidadeEnsino
|Código da unidade de ensino
|Código da unidade de ensino
|
|-
|-
|
|
|periodoLetivo
|periodoLetivo
|Descrição do período letivo, deve ter o mesmo valor da descrição definida na Gestão Escolar. Por exemplo, se deve considerar apenas matrículas do período letivo de 2012, deve ser informado “2012”, exatamente como está cadastrado na gestão Escolar
|Descrição do período letivo, deve ter o mesmo valor da descrição definida na Gestão Escolar. Por exemplo, se deve considerar apenas matrículas do período letivo de 2012, deve ser informado “2012”, exatamente como está cadastrado na gestão Escolar
|
|-
|-
|
|
|codigoCurso
|codigoCurso
|Código do curso que deve ter as matrículas retorna
|Código do curso que deve ter as matrículas retorna
|
|-
|-
|
|
Informando o número exato, será retornada as matrículas especificas daquela série
Informando o número exato, será retornada as matrículas especificas daquela série
|
|-
|-
|
|
|nomeSerie
|nomeSerie
|Nome da série será avaliado no campo da série se o valor contém o registro
|Nome da série será avaliado no campo da série se o valor contém o registro
|
|-
|-
|
|
|Status
|Status
|Indica a situação da série que deve ser considerada (ATIVO, INATIVO)
|Indica a situação da série que deve ser considerada (ATIVO, INATIVO)
|
|-
|-
|
|
|codigoIntegraCurso
|codigoIntegracaoCurso
|Identificador de integração entre o Sistema da ASAS e o da Ultramax no cadastro de cursos de EAD. Vai servir também para identicar qualquer outro sistema de terceiro que utilizar a API de integração de cursos para criar cursos no Gestão Escolar
|Identificador de integração entre o Sistema da ASAS e o da Ultramax no cadastro de cursos de EAD. Vai servir também para identicar qualquer outro sistema de terceiro que utilizar a API de integração de cursos para criar cursos no Gestão Escolar
Informando o código, irá retornar a série correspondente cadastrada
Informando o código, irá retornar a série correspondente cadastrada
|
|-
|
|pagina (paginação)
|Indica qual página está listando na sequência
|
|-
|
|registros (paginação)
|Quantidade de registros que devem ser retornados em cada página
|
|}
|}
====Respostas esperadas====
====ReceitaSerie:====
{| class="wikitable"
{| class="wikitable"
|'''Atributo'''
|'''Atributo'''
|Tamanho
|Tamanho
|-
|-
|'''codigoIntegracaoCurso'''
|codigoContaContabil
|Código identificador do Curso
|Código da conta contábil configurado como uma receita da série
|String
|15
|-
|descricaoContaContabil
|Descrição da conta contábil configurado como uma receita da série
|String
|30
|-
|codigoContaContabilExterna
|Código de conta contábil de contas à receber usado por um sistema terceiro que faz integração com Ultramax Gestão Escolar. usado para realização de "de paras" entre os sistemas. Esse campo pode estar relacionado a mais de uma conta, elas irão ficar separadas por vírgula
|String
|255
|-
|valorTotal
|Valor total de receita configurado para a conta contábil
|Número
|Número
|
|
|-
|-
|'''codigoUnidade'''
|numeroParcelasSugerido
|Código da unidade de ensino que o curso pertence.
|Número de parcelas que será sugerido no momento que uma receita estiver em processo de inclusão para a série
|Número
|Número
|
|
|-
|-
|'''periodoLeletivo'''
|numeroParcelasMaximo
|Descrição do período Letivo atual
|Número de parcelas máximo permitido no momento que uma receita estiver em processo de inclusão para a série
|Texto
|Número
|20
|
|-
|-
|'''codigoCurso'''
|obrigatorio
|Código do curso
|Flag que indica se essa receita é obrigatória na série. Receitas não obrigatórias podem não ser consideradas durante o processo de geação do financeiro para uma matrícula na série
|Texto
|Boleano
|15
|
|}
====Respostas esperadas====
Status 200: : OK ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/series?codigoUnidadeEnsino=1&periodoLetivo=2022 Exemplo])
Status 417: : Caso não seja informado o código da unidade de negócio e a descrição do período letivo ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/series?codigoUnidadeEnsino=1 Exemplo])
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/series?codigoUnidadeEnsino=1&periodoLetivo=2022&sigla=Med Exemplo])
{| class="wikitable"
|'''Atributo'''
|'''Descrição'''
|Tipo
|Tamanho
|-
|-
|'''nomeCurso'''
|codigoIntegracaoCurso
|Nome do curso
|Código identificador do Curso
|Texto
|Texto
|70
|255
|-
|-
|'''numeroSerieDeMatricula'''
|codigoUnidade
|Numero inteiro indicando com a sequência da série no curso que a matrícula deve ser feita. Ex: um curso que tenha
|Código da unidade de ensino que o curso pertence.
|Número
|Número
|
|
|-
|-
|'''nomeSerie'''
|descricaoUnidade
|Nome da série
|Descrição com o nome da unidade de ensino
|Texto
|Texto
|70
|40
|-
|-
|'''Status'''
|periodoLetivo
|Situação da série (ATIVO, INATIVO)
|Descrição do período Letivo atual
|Texto
|20
|-
|codigoCurso
|Código do curso
|Texto
|15
|-
|nomeCurso
|Nome do curso
|Texto
|70
|-
|numeroSequenciaSerie
|Numero inteiro indicando com a sequência da série no curso que a matrícula deve ser feita. Ex: um curso que tenha
|Número
|
|-
|nomeSerie
|Nome da série
|Texto
|70
|-
|Status
|Situação da série (ATIVO, INATIVO, etc..)
|Texto
|Texto
|10
|10
|-
|ReceitaSerie
|Informações referentes a como a série gera receita nas devidas contas contábeis, com o valor do curso e a quantidade de parcelas esperada
|
|0..N
|}
|}
Método: GET
Método: GET
(base)/gestaoescolar/services/v1/turmas?codigoUnidadeEnsino=1&periodoLetivo=2022
(base)/gestaoescolar/services/v1/turmas?codigoUnidadeEnsino=100&periodoLetivo=2022
====Query String (Parâmetros)====
====Query String (Parâmetros)====
|-
|-
|
|
|Status
|status
|Situação possíveis para busca da turma (VIGENTE, EM_FORMACAO,ENCERRADA, TODAS)
|Situação possíveis para busca da turma (VIG, FOR,ENC, TODAS)
|-
|-
|
|
Informando o código, irá retornar a série correspondente cadastrada
Informando o código, irá retornar a série correspondente cadastrada
|-
|
|pagina (paginação)
|Indica qual página está listando na sequência
|-
|
|registros (paginação)
|Quantidade de registros que devem ser retornados em cada página
|}
|}
|
|
|-
|-
|periodoLeletivo
|periodoLetivo
|Descrição do período Letivo atual
|Descrição do período Letivo atual
|Texto
|Texto
|20
|20
|-
|id
|Código identificador interno do Gestão Escolar representando o ID único da turma
|Númerico
|
|-
|-
|codigoCurso
|codigoCurso
|70
|70
|-
|-
|numeroSerieDeMatricula
|numeroSequenciaSerie
|Numero inteiro indicando com a sequência da série no curso que a matrícula deve ser feita. Ex: um curso que tenha
|Numero inteiro indicando com a sequência da série no curso que a matrícula deve ser feita. Ex: um curso que tenha
|Número
|Número
|65
|65
|-
|-
|stutus
|status
|Situação possíveis para busca da turma (VIGENTE, EM FORMAÇÂO,ENCERRADA)
|Situação possíveis para busca da turma (VIG, FOR,ENC) onde VIG = Vigência, FOR = Em formação e ENC = ENCERRADA
|Texto
|Texto
|20
|3
|}
|}
Método: GET
Método: GET
(base)/gestaoescolar/services/v1/matriculas?codigoUnidadeEnsino=1&periodoLetivo=2022
(base)/gestaoescolar/services/v1/matriculas?codigoUnidadeEnsino=100&periodoLetivo=2022
====Query String (Parâmetros)====
====Query String (Parâmetros)====
|-
|-
|
|
|Cpf
|cpf
|Deve ter o valor numérico exato do CPF do aluno
|Deve ter o valor numérico exato do CPF do aluno
|-
|-
|
|
|RM
|cpf_cnpjRespFin
|C.P.F ou C.N.PJ do responsável financeiro.
|-
|
|rm
|Deve ter a String exata que representa a Registro de Matrícula do aluno
|Deve ter a String exata que representa a Registro de Matrícula do aluno
|-
|-
|
|
|statusMatricula
|statusMatricula
|Status da matrícula que deve ser considerada na busca
|Status da matrícula que deve ser considerada na busca. Opções: MAT(Matrículado), ATI(Ativo), PRE (Pré matrícula)
|-
|-
|
|
|Pagina (paginação)
|pagina (paginação)
|Indica qual página está listando na sequência
|Indica qual página está listando na sequência
|-
|-
|
|
|Registros (paginação)
|registros (paginação)
|Quantidade de registros que devem ser retornados em cada página
|Quantidade de registros que devem ser retornados em cada página
|}
|}
|Tamanho
|Tamanho
|-
|-
|sku
|id
|Código identificador único (id)
|Código identificador único de uma matricula do aluno (id). Um aluno pode ter mais pode ter mais de uma matrícula, inclusive no mesmo período letivo. Caso deseje um id exclusivo do aluno, independente da matrícula. Será necessário pegar o id do Aluno que está dentro da matrícula
|Número
|Número
|
|
|Texto
|Texto
|255
|255
|-
|-
|origem
|origem
|StatusMatricula
|StatusMatricula
|Status atual da matrícula
|Status atual da matrícula
PRE Pré Matricula
ATI Ativa
|Texto
MAT Matriculado
|20
CON Concluída
TRF Transferido
TRI Transf. interno
TRC Trancada
DES Desistência/Evasão
CAN Cancelada erro operacional
CAL Cancelada pelo aluno
|StatusMatricula
|1..1
|-
|-
|Turmas
|Turmas
|0..N
|0..N
|-
|-
|codigoCurso
|Serie
|Código do curso
|Dados da série relacionado a matrícula
|Texto
|Serie
|15
|1.1
|-
|-
|nomeCurso
|Curso
|Nome do curso
|Dados do curso relacionado a matrícula
|Texto
|Curso
|70
|1..1
|}
''*Os tipos de dados estão definidos abaixo''
====StatusMatricula:====
{| class="wikitable"
|'''Atributo'''
|'''Descrição'''
|Tipo
|Tamanho
|-
|codigo
|Identificador ATI = Ativa, CAN = Cancelada, CAL = Cancelada pelo aluno, CON = Concluída, DES = Desistência aluno, MAT = Matrículado, PRE = Pré matrícula
|String
|3
|-
|-
|nomeSerie
|descricao
|Nome da série
|Descrição do status matrícula
|Texto
|String
|70
|30
|}
|}
====Responsavel:====
====Sexo:====
{| class="wikitable"
{| class="wikitable"
|'''Atributo'''
|'''Atributo'''
|Tamanho
|Tamanho
|-
|-
|celular
|codigo
|Número do celular do aluno
|Identificador do Sexo (F feminino, M Masculino, N Não declarado)
|Texto
|String
|1
|-
|descricao
|Descrição do sexo
|String
|15
|15
|}
====Estado Civil:====
{| class="wikitable"
|'''Atributo'''
|'''Descrição'''
|Tipo
|Tamanho
|-
|-
|cpf
|codigo
|C.P.F do aluno
|Número identificador
1 = Solteiro , 2 = Casado, 3 = Separado, 4 = Desquitado,5 = Divorciado, 6 = VIÚVO, 7 = OUTROs,8= União estável, 9 = Não informado
|String
|1
|-
|descricao
|Descrição do sexo
|String
|30
|}
====Responsável:====
{| class="wikitable"
|'''Atributo'''
|'''Descrição'''
|Tipo
|Tamanho
|-
|id
|Identificador interno (id)
|Número
|
|-
|celular
|Número do celular do aluno
|Texto
|15
|-
|cpf
|C.P.F do aluno
|Número
|Número
|
|
|-
|-
|endereco
|endereco
|Endeço do Aluno
|Endereço do Aluno
|Endereco
|Endereco
|0..1
|0..1
|estadoCivil
|estadoCivil
|Estado cívil do aluno
|Estado cívil do aluno
|Texto
|EstadoCivil
|30
|0..1
|-
|-
|sexo
|sexo
|Tipo
|Tipo
|Tamanho
|Tamanho
|-
|id
|Identificador interno (id)
|Número
|
|-
|-
|celular
|celular
|-
|-
|endereco
|endereco
|Endeço do Aluno
|Endereço do Aluno
|Endereco
|Endereco
|1..1
|1..1
|estadoCivil
|estadoCivil
|Estado cívil do aluno
|Estado cívil do aluno
|EstadoCivil
|0..1
|-
|rm
|Registro de matrícula do aluno
|Texto
|Texto
|30
|20
|-
|-
|filiacao1
|filiacao1
|Responsavel
|Responsavel
|0..1
|0..1
|-
|responsavelFinanceiro (I)
|Responsável financeiro do aluno
|Responsável
|1..1
|-
|-
|sexo
|sexo
|Sexo
|Sexo
|0..1
|0..1
|-
|urlFotoAwsS3
|URL com o caminho da foto no S3
|Texto
|
|-
|pessoasAutorizadas
|Pessoas que tem autorização para retirar o Aluno
|PessoaAutorizada
|0..N
|}
|}
====Estado:====
====Estado:====
|}
|}
====Turma:====
====PessoaAutorizada:====
{| class="wikitable"
{| class="wikitable"
|'''Atributo'''
|'''Atributo'''
|Tamanho
|Tamanho
|-
|-
|codigoUnidade
|nome
|Código da unidade de ensino que o curso pertence.
|Nome da Pessoa
|Número
|Texto
|
|
|-
|-
|periodoLeletivo
|rg
|Descrição do período Letivo atual
|RG com número da pessoa autorizada
|Texto
|Texto
|20
|
|-
|-
|sigla
|parentesco
|Código do curso
|descrição com o parentesco da pessoa autorizada
|Texto
|Texto
|15
|
|-
|-
|nomeCurso
|cpf
|Nome do curso
|CPF da pessoa autorizada a retirar
|Texto
|Texto
|
|
|}
|}
==APIS para manutenção da base de dados==
===Resumo financeiro: Obtendo dados:===
Busca o resumo financeiro sumarizado por tipo de movimentação financeira ("Receber" e "Pagar") e contas contábeis dentro do intervalo de datas informado.
Método: GET
(base)/gestaoescolar/services/v1/resumofinanceiro?inicio=01/01/2022&fim=31/12/2021&tipoPesquisaData=FATURAMENTO
====Query String (Parâmetros)====
====Body====
{| class="wikitable"
{| class="wikitable"
|'''Atributo'''
|Obrigatório
|'''Descrição'''
|Campo
|Tipo
|Descrição
|Mínimo
|-
|Máximo
|Sim
|inicio
|Data de inicio considerando o data de faturamento da movimentação financeira no formato dd/MM/aaaa
|-
|-
|'''sigla'''
|Sim
|Código identificador do Curso
|fim
|S
|Data de termino considerando o data de faturamento da movimentação financeira no formato dd/MM/aaaa
|-
|-
|'''codigoUnidade'''
|
|tipPesquisaData
|Define qual o tipo de pesquisa será realizada nas datas
O padrão é '''VENCIMENTO''', que irá filtrar pela data de vencimento dos títulos
'''FATURAMENTO''', que irá filtrar pela data de faturamento
'''PAGAMENTO''', que irá filtrar pela data de pagamento dos títulos, o que considera apenas títulos já baixados
Qualquer outro valor não irá retornar dados
|-
|-
|'''nome'''
|
|Descrição do curso
|exibeDetalhesTitulo
|Valor booleano (true/false ou 0/1) indicando se deve ou não exibir os detalhes dos movimentos financeiros que foram sumarizados, quando marcado com true irá retornar uma lista de DadosTitulos com informações analíticas, o que pode tornar o arquivo de retorno grande, caso o intervalo de datas informado seja grande
|1
|-
|-
|'''itemServico'''
|
|Código do serviço para emissão de NFS-e. Depende de cada instituição e do curso. Por exemplo: 05673. Ver com a instituição qual código usar para cada curso
|pagina (paginação)
|Indica qual página está listando na sequência
|-
|-
|'''codigoIntegracao'''
|
|Código único de integração, será a chave entre os diferentes sistemas
|registros (paginação)
|S
|Quantidade de registros que devem ser retornados em cada página
|}
|Natureza de operação será usada na geração das notas fiscais
====Respostas esperadas====
Status 200: : OK
Status 417: : Caso não seja informado o código da unidade de negócio e a descrição do período letivo
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado
{| class="wikitable"
|'''Atributo'''
|'''Descrição'''
|Tipo
|Tamanho
|-
|mes
|Representação numérica com o mês que foi contabilizado (Exemplo: janeiro = 1)
|Número
|
|-
|ano
|Ano que foi contabilizado
|Número
|
|-
|codigoContaContabil
|Código com a conta contábil contabilizada
|Texto
|15
|-
|descricaoContaContabil
|Descrição da conta contábil contabilizada
|Texto
|30
|-
|codigoContaContabilExterna
|Código utilizada por um sistema externo com a conta contábil contabilizada, esse caso é para associar um "de para" entre a conta contágio do Ultramax Gestão Escolar e um sistema externo. Esse campo pode estar associada a mais de uma conta contábil externa, elas irão retornar separadas por vírgula
|Texto
|255
|-
|tipo
|Tipo da movimentação financeira contabilizada. Os tipos podem ser "Receber" e "Pagar"
|Texto
|7
|-
|valor
|Valor total sumarizado por mês/Ano/Tipo/Conta Contábil
|Número
|
|-
|percentualValorRelacaoTotal
|O quanto equivale em percentual em relação ao Total geral por Tipo dentro do intervalo pesquisado
|Número
|
|-
|DadosTitulos
|Lista com os detalhes dos títulos que foram sumarizados em cada um dos registros retornados
|
|
|}
=====DadosTitulos:=====
{| class="wikitable"
|'''Atributo'''
|'''Descrição'''
|Tipo
|Tamanho
|-
|nome
|Nome da pessoa associada ao título (responsável pelo pagamento)
|Texto
|70
|-
|dataDePagamento
|Data que o pagamento do título foi efetivado
|Texto
|10
|-
|dataFaturamento
|A data que a nota fiscal associada ao boleto/título foi gerada, ou, caso ainda não tenha sido gerada, a Data prevista para faturamento (data associada ao título no Gestão Escolar)
|Texto
|10
|-
|vencimento
|Data de vencimento prevista para o título
|Texto
|10
|-
|inicioCurso
|Data com início que a matrícula do aluno está configurado
|Texto
|10
|-
|curso
|Nome do curso que está associada a matrícula
|Texto
|70
|-
|rm
|RA do aluno com identificador único
|Texto
|20
|-
|status
|Situação atual da matrícula
|Texto
|30
|-
|turma
|Turma principal associada a matricula
|Texto
|65
|-
|valorCobrado
|Valor efetivamente cobrado para o título (baixado)
|Numero
|
|-
|valorDocumento
|Valor base esperado para o título (não considera descontos configurados)
|Número
|
|}
===Enturmamento aluno===
Realiza a busca dos alunos e as turmas que frequentam com disciplina no modelo especifico do google for education. Para que seja retornado deve seguir os seguintes pré requisitos:
*Matrícula deve ter o status matriculado ou ativa
*A turma deve ter status diferente de encerrado
*O cursa do aluno deve ter o status cursando
*A série deve estar ativa
*O curso não deve estar com o campo "Não enviar na API de enturmamento" selecionado
Método: GET
(base)/gestaoescolar/services/enturmamento/rest/aluno
====Query string (parâmetro)====
{| class="wikitable"
|+
!Obrigatório
!Campo
!Descrição
|-
|Sim
|portal
|Portal externo que deseja buscar o enturmamento dos alunos, o e-mail do aluno no retorno será o de login a esse portal, os valores aceitos são:
-GOOGLE_FOR_EDUCATION;
-MICROSOFT_TEAMS;
|}
|}
====Respostas esperadas====
====Respostas esperadas====
Status 200: Status Processamento: OK
Status 200: : OK
Status 417: Status Processamento: JACADASTRADO. Quando a mesma sigla de curso está cadastrado em mais de um registro.
Status 417: : Caso não seja informado o portal ou o mesmo não seja cadastrado na escola
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado
{| class="wikitable"
|+
!Atributo
!Descrição
!Tipo
!Tamanho
|-
|CURSO_CODIGO
|Código do curso
|Texto
|15
|-
|CURSO_ID
|Identificador do curso
|Número
|
|-
|CURSO_NOME
|Nome do curso
|Texto
|70
|-
|DISCIPLINA_CODIGO
|Identificador da disciplina
|Número
|
|-
|DISCIPLINA_NOME
|Nome da disciplina
|Texto
|200
|-
|IE_CODIGO
|Código da instituição de ensino fornecido pelo portal externo
|Texto
|
|-
|IE_ID
|Identificado da instituição de ensino fornecido pelo portal externo
|Texto
|
|-
|'''Atributo'''
|IE_NOME
|'''Descrição'''
|Nome da instituição de ensino fornecido pelo portal externo
|Tipo
|Texto
|Mínimo
|
|Máximo
|-
|PERIODO_CODIGO
|Identificador do período letivo
|Número
|
|-
|PERIODO_LETIVO
|Nome do período letivo
|Número
|
|-
|SERIE_CODIGO
|Código para a série concatenando código do curso e seqência da série no curso
|Texto
|
|-
|SERIE_ID
|Identificador da série
|Número
|
|-
|-
|'''nome'''
|SERIE_NOME
|Nome do aluno.
|Nome da série
|S
|Texto
|70
|70
|-
|-
|'''celular'''
|TURMA_CODIGO
|Número de telefone celular Ex: 11998465521 ou (11) 99999-9999
|Replica o nome da turma
|S
|Texto
|11
|65
|15
|-
|TURMA_DISCIPLINA_CODIGO
|Código que associa a turma com a disciplina no quadro curricular
|Número
|
|-
|-
|'''cpf'''
|TURMA_ID
|Sequencia numérica com o CPF do aluno Ex. 65696655565
|Identificador da turma
|N
|Número
|11
|
|-
|-
|'''email'''
|TURMA_NOME
|Email do aluno Ex: aluno@aluno.com.br
|Nome da turma
|S
|Texto
|>1
|65
|-
|-
|'''enderecoBairro'''
|ALUNO_RA
|Bairro do end residencial do aluno Ex. vila didi
|RM do aluno
|Texto
|1
|20
|60
|-
|-
|'''enderecoCep'''
|ALUNO_ID
|CEP do end residencial do aluno Ex. 13203320
|Identificador do aluno
|Número
|8
|
|8
|-
|-
|'''enderecoCidade'''
|ALUNO_NOME
|Cidade do end residencial do aluno Ex. jundiai
|Nome do aluno
|Texto
|1
|70
|20
|-
|-
|'''enderecoComplemento'''
|ALUNO_EMAIL
|Complemento do end residencial do aluno Ex. casa
|E-mail do aluno para acesso ao portal
|Texto
|0
|255
|60
|-
|-
|'''enderecoEstado'''
|ALUNO_CPF
|Estado do end residencial do aluno Ex. SP Max 2 caracteres deve ser a sigla correspondente ao Estado
|CPF do aluno
|Número
|2
|
|2
|-
|-
|'''enderecoLogradouro'''
|RESP_PED_NOME
|Logradouro do end residencial do aluno Ex. rua guapore
|Nome do responsável pedagógico
|Texto
|1
|70
|60
|-
|-
|'''enderecoNumero'''
|RESP_PED_EMAIL
|Número do end residencial do aluno Ex. 521
|E-mail pessoal do responsável pedagógico
|S
|Texto
|0
|255
|}
===Enturmamento professor===
Realiza a busca dos professores e as turmas que lecionam com disciplina no modelo especifico do google for education. Para que seja retornado deve seguir os seguintes pré requisitos:
*O período letivo deve estar ativo
*Turma tem que ter status diferente de encerrado
*A série deve estar ativa
*O curso não deve estar com o campo "Não enviar na API de enturmamento" selecionado
Método: GET
(base)/gestaoescolar/services/enturmamentoProfessor/rest/professor
====Query string (parâmetro)====
{| class="wikitable"
|+
!Obrigatório
!Campo
!Descrição
|-
|-
|'''nascimento'''
|Sim
|Date com a data de nascimento do aluno dd/MM/yyyy
|portal
|S
|Portal externo que deseja buscar o enturmamento dos professor, o e-mail do aluno no retorno será o de login a esse portal, os valores aceitos são:
-GOOGLE_FOR_EDUCATION;
-MICROSOFT_TEAMS;
|}
|S
====Respostas esperadas====
|>1
Status 200: : OK
Status 417: : Caso não seja informado o portal ou o mesmo não seja cadastrado na escola
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado
{| class="wikitable"
|+
!Atributo
!Descrição
!Tipo
!Tamanho
|-
|-
|'''sexo'''
|CURSO_CODIGO
|Indicador do gênero do aluno Ex MASCULINO.
|Código do curso
|Texto
|8
|15
|15
|-
|-
|'''nacionalidade'''
|CURSO_ID
|Nacionalidade do aluno
|Identificador do curso
|S
|Número
|0
|
|30
|-
|CURSO_NOME
|Nome do curso
|Texto
|70
|-
|-
|'''filiacao1'''
|DISCIPLINA_CODIGO
|Filiação 1 do aluno (Detalhes tabela pessoa)
|Identificador da disciplina
|Número
|
|
|
|-
|-
|'''filiacao2'''
|DISCIPLINA_NOME
|Filiação 2 do aluno (Detalhes tabela pessoa)
|Nome da disciplina
|PessoaRemote
|Texto
|200
|-
|IE_CODIGO
|Código da instituição de ensino fornecido pelo portal externo
|Texto
|
|-
|IE_ID
|Identificado da instituição de ensino fornecido pelo portal externo
|Texto
|
|-
|IE_NOME
|Nome da instituição de ensino fornecido pelo portal externo
|Texto
|
|-
|PERIODO_CODIGO
|Identificador do período letivo
|Número
|
|
|-
|PERIODO_LETIVO
|Nome do período letivo
|Número
|
|
|-
|-
|'''rm'''
|SERIE_CODIGO
|Código de matrícula que deve ser informado apenas quando o autonumeração de RM está desligada no Gestão Escolar
|Código para a série concatenando código do curso e seqência da série no curso
|S
|Texto
|0*
|
|20
|-
|}
|SERIE_ID
|Identificador da série
|Número
|
|-
|SERIE_NOME
|Nome da série
|Texto
|70
|-
|TURMA_CODIGO
|Replica o nome da turma
|Texto
|65
|-
|TURMA_DISCIPLINA_CODIGO
|Código que associa a turma com a disciplina no quadro curricular
|Número
|
|-
|TURMA_ID
|Identificador da turma
|Número
|
|-
|TURMA_NOME
|Nome da turma
|Texto
|65
|-
|PROFESSOR_CODIGO
|Replica o identificador do professor
|Número
|
|-
|PROFESSOR_CPF
|CPF do professor
|Número
|
|-
|PROFESSOR_EMAIL
|E-mail do professor para acesso ao portal externo
|Texto
|255
|-
|PROFESSOR_ID
|Identificador do professor
|Número
|
|-
|PROFESSOR_NOME
|Nome do professor
|Texto
|70
|-
|PROFESSOR_PERFIL
|Retorna fixo o valor 4
|Texto
|
|-
|TURMA_DISCIPLINA_PERFIL
|Retorna fixo o valor 4
|Texto
|
|-
|TURMA_TIPO_ID
|Retorna fixo o valor 4
|Texto
|
|}
===Cadastrar chave do aluno===
Realiza a atualização no perfil do aluno cadastrando a chave de acesso para aquele portal.
Método: POST
(base)/gestaoescolar/services/chavePortal/rest/aluno
====Query string (parâmetro)====
{| class="wikitable"
|+
!Obrigatório
!Campo
!Descrição
|-
|Sim
|portal
|Portal externo no qual deve ser cadastrada a chave de acesso do aluno, os valores aceitos são:
-GOOGLE_FOR_EDUCATION;
-MICROSOFT_TEAMS;
|-
|Sim
|atualizar
|Coleção de alunos que devem ser atualizados, cada elemento deve ter o identificador do aluno e o login daquele aluno no portal, serão respectivamente os campos id e chave
|}
'''Exemplo:'''
{
"portal":"GOOGLE_FOR_EDUCATION",
"atualizar":[
{
"nome": "wescley",
"chave": "alu3@email.com",
"rg": "584245999",
"id": 5
}
]
}
====Respostas esperadas====
Status 200: : OK
Status 417: : Caso não seja informado o portal ou o mesmo não seja cadastrado na escola ou caso de erro de validação no processo de gravação que será especificado no retorno.
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado
===Cadastrar chave do professpr===
Realiza a atualização no perfil do professor cadastrando a chave de acesso para aquele portal.
Método: POST
(base)/gestaoescolar/services/chavePortal/rest/professor
====Query string (parâmetro)====
{| class="wikitable"
|+
!Obrigatório
!Campo
!Descrição
|-
|Sim
|portal
|Portal externo no qual deve ser cadastrada a chave de acesso do aluno, os valores aceitos são:
-GOOGLE_FOR_EDUCATION;
-MICROSOFT_TEAMS;
|-
|Sim
|atualizar
|Coleção de professores que devem ser atualizados, cada elemento deve ter o identificador do professor e o login daquele professor no portal, serão respectivamente os campos id e chave
|}
'''Exemplo:'''
{
"portal":"GOOGLE_FOR_EDUCATION",
"atualizar":[
{
"chave": "alu3@email.com",
"id": 5
}
]
}
====Respostas esperadas====
Status 200: : OK
Status 417: : Caso não seja informado o portal ou o mesmo não seja cadastrado na escola ou caso de erro de validação no processo de gravação que será especificado no retorno.
====Body====
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado
{| class="wikitable"
==APIS para manutenção da base de dados==
|'''Atributo'''
|'''Descrição'''
===Manutenção de cursos===
Faz a manutenção de um curso. Através do código de integração será localizado um curso existente para alteração ou, caso não exista, será criado um novo curso
Método: Post
(base)/gestaoescolar/services/curso/rest/add
====Body====
{| class="wikitable"
|'''Atributo'''
|'''Descrição'''
|Tipo
|Tipo
|Mínimo
|Mínimo
|Máximo
|Máximo
|-
|-
|'''cpf_cnpj'''
|'''sigla'''
|CPF do aluno que será gerada a matrícula, apenas numeros
|Código identificador do Curso
|S
|S
|1
|1
|255
|15
|-
|-
|'''codigoUnidade'''
|'''codigoUnidade'''
|3
|3
|-
|-
|'''numeroSerieDeMatricula'''
|'''nome'''
|numero inteiro indicando com a sequência da série no curso que a matrícula deve ser feita. Ex: um curso que tenha três séries e a matrícula deve ser feita no primeira delas, deve passar 1
|Descrição do curso
|N
|S
|1
|1
|3
|70
|-
|-
|'''valor'''
|'''itemServico'''
|Valor total do curso. Ex. 1000.0
|Código do serviço para emissão de NFS-e. Depende de cada instituição e do curso. Por exemplo: 05673. Ver com a instituição qual código usar para cada curso
|N
|S
|
|4
|
|9
|-
|-
|'''quantidadeParcelas'''
|'''codigoIntegracao'''
|Quantidade de parcelas. Ex 1
|Código único de integração, será a chave entre os diferentes sistemas
|N
|S
|1
|1
|3
|255
|-
|-
|'''formaPagamento'''
|'''modalidadeCurso'''
|Forma de pagamento que deve usado na baixa do título.
|‘EAD’ fixo
|S
|S
|1
|1
|50
|30
|-
|-
|'''titulos'''
|'''naturezaOperacao'''
|Lista de títulos que foram gerados e que precisam ser compartilhados com o Gestão Escolar. Eles ficarão marcados no sistema Gestão Escolar como "pagamento de terceiro" e a sua baixa, alteração ou cancelamento devem ser feitas pelas Apis que serão descritas na parte financeira desse documento
|Natureza de operação será usada na geração das notas fiscais
Valores válidos:
CANCELADO("Cancelado"),
EXIGIBILIDADE_SUSPENSAO_DECISAO_JUDICAL(
"Exigibilidade por suspensão de decisão judicial - Válido até 22/02/2015"),
EXIGIBILIDADE_SUSPENSAO_DECISAO_JUDICAL_2(
"Exigibilidade por suspensão de decisão judicial"),
EXIGIBILIDADE_SUSPENSAO_PROCEDIMENTO_ADM(
"Exigibilidade por suspensão de procedimento administrativo - Válido até 22/02/2015"),
EXIGIBILIDADE_SUSPENSAO_PROCEDIMENTO_ADM_2(
"Exigibilidade por suspensão de procedimento administrativo"),
EXIGIBILIDADE_SUSPENSAO_TRIBUTADO_FORA_MUNICIPIO(
"dados": {
"Tributado fora do Munícipio, porém Exigibilidade Suspensa - Válido a partir de 23/02/2015"),
EXIGIBILIDADE_SUSPENSAO_TRIBUTADO_MUNICIPIO(
"cpf_cnpj": 2865474325,
"Tributado no Munícipio, porém Exigibilidade Suspensa - Válido a partir de 23/02/2015"),
EXPORTACAO( "Exportação"),
EXPORTACAO_SERVICO(
"codigoUnidade":1,
"Exportação de serviços - Válido a partir de 23/02/2015"),
EXTRAVIADO("Extraviado - Válido até 22/02/2015"),
IMUNE("Imune - Válido até 22/02/2015"),
IMUNIDADE("Imunidade"),
ISENCAO("Isenção - Válido até 22/02/2015"),
ISENCAO_ATUAL("Isenção"),
MICRO_EMPREENDEDOR_INDIVIDUAL("Micro Empreendedor Individual (MEI)"),
SIMPLES("Simples Nacional"),
TRIBUTACAO_FORA_MUNICIPIO("Tributação fora do munipio"),
TRIBUTACAO_MUNICIPIO("Tributação no municipio"),
TRIBUTADO_FORA_MUNICIPIO_IMUNE()
"acao": "Manutenção OK"
"Tributado fora do município, porém Imune - Válido a partir de 23/02/2015"),
TRIBUTADO_FORA_MUNICIPIO_ISENTO(
"Tributado fora do município, porém Isento - Válido a partir de 23/02/2015"),
TRIBUTADO_MUNICIPIO_IMUNE("Tributado no município, porém Imune - Válido a partir de 23/02/2015"),
TRIBUTADO_MUNICIPIO_ISENTO("Tributado no município, porém Isento - Válido a partir de 23/02/2015");
|N
|N
|1
|1
|60
|50
|-
|}
====Respostas esperadas====
Status 200: Status Processamento: OK
Status 417: Status Processamento: JACADASTRADO. Quando a mesma sigla de curso está cadastrado em mais de um registro.
Status 500: Status Processamento: ERRO
====Exemplo:====
=====Requisição=====
{"sigla":"Curso","codigoUnidade":1,"nome":"Curso teste","itemServico":"545454","codigoIntegracao":"SA-KJ-AD-NB","modalidadeCurso":"EAD"}
=====Resposta=====
{
"dados": {
|-
|'''enderecoEstado'''
"sigla": "Curso",
"codigoUnidade":1,
"nome": "Curso teste",
|'''enderecoLogradouro'''
"itemServico": "545454",
|Logradouro do end residencial do aluno Ex. rua guapore
|S
"codigoIntegracao": "SA-KJ-AD-NB",
|60
"modalidadeCurso": "EAD"
},
"statusProcessamento": "OK",
"response": "ACCEPTED",
"acao": "Manutenção OK"
}
===Manutenção de alunos===
Adiciona ou altera um aluno. Através do C.P.F informado será localizado na base de dados do gestão escolar o aluno correspondente. Caso encontre, será atualizado todos os campos bases enviados no header, por outro lado, caso não encontre, será incluído um novo registro para o aluno.
Método: Post
(base)/gestaoescolar/services/aluno/rest/responsavelfinanceiro
====Body====
{| class="wikitable"
|'''Atributo'''
|'''Descrição'''
|Tipo
|Mínimo
|Máximo
|-
|-
|'''enderecoNumero'''
|'''nome'''
|Número do end residencial do aluno Ex. 521
|Nome do aluno.
|S
|S
|0
|1
|7
|70
|-
|-
|'''nascimento'''
|'''celular'''
|Date com a data de nascimento do aluno dd/MM/yyyy
|Número de telefone celular Ex: 11998465521 ou (11) 99999-9999
|S
|S
|10
|11
|10
|15
|-
|'''cpf'''
|Sequencia numérica com o CPF do aluno Ex. 65696655565
|N
|11
|11
|-
|-
|'''rg'''
|'''email'''
|RG do aluno Ex: 584245999
|Email do aluno Ex: aluno@aluno.com.br
|S
|S
|>1
|>1
|25
|255
|-
|-
|'''sexo'''
|'''enderecoBairro'''
|Indicador do gênero do aluno Ex MASCULINO.
|Bairro do end residencial do aluno Ex. vila didi
|S
|S
|1
|60
|-
|'''enderecoCep'''
|CEP do end residencial do aluno Ex. 13203320
|S
|8
|8
|8
|-
|-
|'''nacionalidade'''
|'''enderecoCidade'''
|Nacionalidade do aluno
|Cidade do end residencial do aluno Ex. jundiai
|S
|1
|20
|-
|'''enderecoComplemento'''
|Complemento do end residencial do aluno Ex. casa
|S
|S
|0
|0
|30
|60
|}
|-
|'''enderecoEstado'''
|Estado do end residencial do aluno Ex. SP Max 2 caracteres deve ser a sigla correspondente ao Estado
|S
|2
|2
|-
|'''Atributo'''
|'''enderecoLogradouro'''
|'''Descrição'''
|Logradouro do end residencial do aluno Ex. rua guapore
|Tipo
|S
|Mínimo
|1
|Máximo
|60
|-
|'''enderecoNumero'''
|Número do end residencial do aluno Ex. 521
|S
|0
|7
|-
|-
|'''dataVencimento'''
|'''nascimento'''
|Data de vencimento do título
|Date com a data de nascimento do aluno dd/MM/yyyy
|S
|S
|10
|10
|10
|10
|-
|-
|'''nossoNumero'''
|'''rg'''
|Número gerado pelo sistema interno que criou o título e que deve ser compartilhado com o Gestão Escolar para que cada interação funcione de forma correta
|RG do aluno Ex: 584245999
|S
|S
|1
|>1
|50
|25
|-
|'''sexo'''
|Indicador do gênero do aluno Ex MASCULINO.
MASCULINO/FEMININO/NAODECLARADO
|S
|8
|15
|-
|'''nacionalidade'''
|Nacionalidade do aluno
|S
|0
|30
|-
|-
|'''valorDocumento'''
|'''filiacao1'''
|Valor que representa o título
|Filiação 1 do aluno (Detalhes tabela pessoa)
|N
|PessoaRemote
|
|
|
|
|}
|-
|'''filiacao2'''
|Filiação 2 do aluno (Detalhes tabela pessoa)
|PessoaRemote
|
|
|-
|'''rm'''
|Código de matrícula que deve ser informado apenas quando o autonumeração de RM está desligada no Gestão Escolar
|S
|0*
|20
|}
====Filiação====
Usado nos dados do aluno para representar uma filiação.
{| class="wikitable"
{| class="wikitable"
|Máximo
|Máximo
|-
|-
|'''dataVencimento'''
|'''nome'''
|Data de vencimento do título
|Nome do aluno.
|S
|S
|10
|1
|10
|70
|-
|-
|'''nossoNumero'''
|'''celular'''
|Número gerado pelo sistema interno que criou o título e que deve ser compartilhado com o Gestão Escolar para que cada interação funcione de forma correta
|Número de telefone celular Ex: 11998465521 ou (11) 99999-9999
|S
|S
|1
|11
|50
|15
|-
|-
|'''valorDocumento'''
|'''cpf'''
|Valor que representa o título
|Sequencia numérica com o CPF do aluno Ex. 65696655565
|N
|N
|
|11
|
|11
|}
|-
|'''email'''
'''Respostas esperadas'''
|Email do aluno Ex: aluno@aluno.com.br
|S
|>1
|255
|-
|'''enderecoBairro'''
|Bairro do end residencial do aluno Ex. vila didi
|S
|1
|60
|-
|'''enderecoCep'''
|CEP do end residencial do aluno Ex. 13203320
|S
|8
|8
|-
|'''enderecoCidade'''
|Cidade do end residencial do aluno Ex. jundiai
|S
|1
|20
|-
|'''enderecoComplemento'''
|Complemento do end residencial do aluno Ex. casa
|S
|0
|60
|-
|'''enderecoEstado'''
|Estado do end residencial do aluno Ex. SP Max 2 caracteres deve ser a sigla correspondente ao Estado
|S
|2
|2
|-
|'''enderecoLogradouro'''
|Logradouro do end residencial do aluno Ex. rua guapore
|S
|1
|60
|-
|'''enderecoNumero'''
|Número do end residencial do aluno Ex. 521
|S
|0
|7
|-
|'''nascimento'''
|Date com a data de nascimento do aluno dd/MM/yyyy
|S
|10
|10
|-
|'''rg'''
|RG do aluno Ex: 584245999
|S
|>1
|25
|-
|'''sexo'''
|Indicador do gênero do aluno Ex MASCULINO.
MASCULINO/FEMININO
|S
|8
|15
|-
|'''nacionalidade'''
|Nacionalidade do aluno
|S
|0
|30
|}
====Respostas esperadas====
Status 200: Status Processamento: OK
Status 417: Status Processamento: ERRO, JACADASTRADO
Status 500: Status Processamento: ERRO
====Exemplo====
=====Requisição=====
{"celular":"11998465521","cpf":2865474325,"email":"wescleyfcosta@gmail.com","enderecoBairro":"vila didi","enderecoCep":"13203320","enderecoCidade":"jundiai","enderecoComplemento":"casa","enderecoEstado":"SP","enderecoLogradouro":"rua guapore","enderecoNumero":"521","nascimento":319518000000,"nome":"wescley","rg":"584245999","sexo":"MASCULINO"}
=====Resposta=====
{
"dados": {
"celular": "11998465521",
"cpf": 2865474325,
"email": "wescleyfcosta@gmail.com",
"enderecoBairro": "vila didi",
"enderecoCep": "13203320",
"enderecoCidade": "jundiai",
"enderecoComplemento": "casa",
"enderecoEstado": "SP",
"enderecoLogradouro": "rua guapore",
"enderecoNumero": "521",
"nascimento": 319518000000,
"nome": "wescley",
"rg": "584245999",
"sexo": "MASCULINO"
},
"statusProcessamento": "OK",
"response": "ACCEPTED",
"acao": "Manutenção OK"
}
Validações possíveis:
Existem diversas validações internas que podem retornar uma falha ao cadastrar um aluno. São elas:
- Trocar senha com perfil de autenticação inválido
- O cadastro do aluno não está mais ativo
*- O formato do CPF é inválido
- Informou uma senha que não está dentro das regras definidas na configuração
- Quando a configuração não for autonumeração de RM e passar um RM que já existe para outro CPF (Vai dar o JACADASTRADO)
* - O responsável financeiro for menor que 18 anos
* - Quando o endereço residencial do aluno não é fornecido
Os marcados com * são os que podem ocorrer usando essa API
===Manutenção de matrículas===
Adiciona ou altera uma matrícula. Pelo código da matrícula único, código de integração entre os sistemas, será possível atualizar os dados de uma matrícula, caso ela exista, ou incluir uma nova.
Método: Post
(base)/gestaoescolar/services/matricula/rest/add
(base)/gestaoescolar/services/financeiro/rest/titulo
====Body====
{| class="wikitable"
{| class="wikitable"
|'''Atributo'''
|'''Atributo'''
|Máximo
|Máximo
|-
|-
|'''nossoNumero'''
|'''cpf_cnpj'''
|Número gerado pelo sistema interno que criou o título e que deve ser compartilhado com o Gestão Escolar para que cada interação funcione de forma correta
|CPF do aluno que será gerada a matrícula, apenas numeros
|N
|11
|11
|-
|'''codigoIntegracao'''
|Código de integração para um Curso existente
|S
|S
|1
|1
|50
|255
|}
|-
|'''codigoMatriculaUnico'''
|Código de integração para busca de uma matrícula ou para criar uma nova
|S
|1
|255
|-
|'''codigoUnidade'''
|Código da unidade de ensino que o curso pertence. Fixo "1"
|N
|1
|3
|-
|'''numeroSerieDeMatricula'''
|numero inteiro indicando com a sequência da série no curso que a matrícula deve ser feita. Ex: um curso que tenha três séries e a matrícula deve ser feita no primeira delas, deve passar 1
|N
|1
|3
|-
|'''valor'''
|Valor total do curso. Ex. 1000.0
|N
|
|
|-
|'''quantidadeParcelas'''
|Quantidade de parcelas. Ex 1
|N
|1
|3
|-
|'''formaPagamento'''
|Forma de pagamento que deve usado na baixa do título.
Valores válidos:
DINHEIRO, CHEQUE, C_CREDITO,C_DEBITO, BOLETO, DEB_AUTOMATICO,TRANSFERENCIA, DOC,OUTRO_BAIXA_ADM,DEPOSITO,DUPLICADA, FIES, PREFEITURA,PROUNI, FOLHA_DE_PGTO, CHEQUE_PRE,PAGAMENTO_ONLINE, PERMUTA, PIX
Deixe null caso não seja necessário a baixa durante a inclusão da matrícula
|S
|3
|20
|-
|'''origem'''
|Origem da matrícula, como padrão "Plataforma EAD"
|S
|1
|50
|-
|'''titulos'''
|Lista de títulos que foram gerados e que precisam ser compartilhados com o Gestão Escolar. Eles ficarão marcados no sistema Gestão Escolar como "pagamento de terceiro" e a sua baixa, alteração ou cancelamento devem ser feitas pelas Apis que serão descritas na parte financeira desse documento
Detalhes da api na tabela TituloRemote
|Titulo
|
|
|-
|'''notificarAlunoAcessoPortal'''
|Quando esse atributo for marcado como verdadeiro será enviado o email de qual a senha dele para o aluno (passe true ou false / 0 false e 1 para verdadeira. Qualquer coisa diferente de true no texto, será false)
|S
|4
|6
|-
|'''periodoLetivo'''
|Caso informado, deve-se passar a descrição do período letivo que foi cadastrado no sistema Gestão Escolar. caso informe uma descrição de período letivo inexistente, irá retornar o erro 417. A descrição padrão usada nas buscas é "EAD".
|S
|0
|20
|}
====Respostas esperadas====
Status 200: Status Processamento: OK
Status 417: Status Processamento: JACADASTRADO (quando existe uma outra matrícula não cancelada no mesmo período letivo)
Status 417: Status Processamento: CURSO_NAO_EXISTE (quando o código de integração informado não encontrou um curso correspondente cadastrado)
Status 417: Status Processamento: ALUNO_NAO_EXISTE (quando o C.P.F informado não encontrou um aluno correspondente cadastrado)
Status 417: Status Processamento: TITULO_NAO_EXISTE (Quando o título informado não existe)
Status 500: Status Processamento: ERRO
======Principais validações conhecidas referentes ao erro HTTP 417: Regras de negócio======
Manutenção de matrícula
- Ter um código sku (identificador único)
Atualização
- Não pode o código Identificador único da matrícula estar associado a Outro CPF
Erro: Já existe um aluno com CPF diferente ({0}) usando o mesmo código de mátricula único {1}
"valorDocumento": 1000.0,
- O código integração do curso "codigoIntegracao" deve estar associado a algum curso no GE
Erro: Código SKU do curso não foi informado
"valorMoraMulta": 0.0,
- O código integração do curso "codigoIntegracao" deve ser igual ao código de integração de cursa da matrícula já existente
Erro: O código de integração do curso ({0}) não é o mesmo código SKU já definido para a matrícula: {1}
- Caso a matrícula existente não seja uma pré matrícula e não tenha nenhuma disciplina já associada (cursa)
Erro: A matrícula {0} não tem nenhuma disciplina associada
Inclusão
- codigoIntegracao fornecido não está associado a nenhum curso no GE
Erro: Não foi localizado o curso correspondente para o código {0}
- atributo cpf_cnpj fornecido não está associado a nenhum aluno no GE (Precisa cadastro o aluno antes)
Erro: Não foi localizado o curso correspondente para o código {0}
- atributo codigoUnidade fornecido não tem uma unidade de ensino com o mesmo código no GE
Erro: Não foi possível determinar qual será a unidade de ensino com o código {0} para a matrícula.
{| class="wikitable"
- atributo periodoLetivo fornecido não tem um período letivo correspondente no GE
Erro: ão foi possível determinar qual será a período letivo com o código {0} para a matrícula. Por favor entrar em contato com a secretaria e buscar no Wiki do sistema pelo código de ajuda: CFGAPI001
- atributos numeroSerieDeMatricula e a combição dos atributo codigoIntegracao(curso), codigoUnidade (Unidade de ensino) e periodoLetivo (período letívo) devem localizar a série/turma que o aluno deve ser matrículado,
Erro: Não foi possível determinar qual será a série para a matrícula: Sequência: {0}.
- atributo codigoIntegracao localizar um curso com modalidade EAD e valor do atributo valor for maior que zero e a série localizada não tiver mais de
uma receita obrigatória cadastrada
Erro: A série deve conter apenas uma receita obrigatória. Por favor entrar em contato com a secretaria e buscar no Wiki do sistema pelo código de ajuda: CFGAPI001
Geração dos boletos:
- Caso a matrícula tenha Tenha o atributo do valor maior que zero, e a modalidade do curso referente ao atributo codigoIntegracao for EAD
e não tiver nenhum atributo "titulos" fornecido, o processo vai tentar criar os títulos financeiros de acordo com o configurado na aba financeiro
no gestão escolar e caso alguma despesa da matrícula existente não esteja configurada no financeiro da série dará o erro:
Erro: A conta contábil de recebimento não está configurado na parte financeira da série para a receita:
- Caso o atributo "titulos" esteja preenchido e a somatória do atributo do titulo chamado valorDocumento não bater com o atributo "valor" do
corpo da matrícula.
Erro: O valor total informado ({0}) não bate com a somatória de valores de cada parcela ({1})
- Caso o curso associado seja da modalidade EAD e tenha o atributo valor maior que zero e a matrícula gerada durante a chamada fique sem nenhuma
despesa de matrícula associada
Erro: Não existe nenhuma despesa configurada para a matrícula, verifique se existe configuração de despesa financeira para a série {0} e então, inclua uma despesa para a matrícula.
- Caso o atributo "nossoNumero" do titulo já esteja associado a algum outro boleto no Gestão Escolar
Erro: O título com o código externo {0} já existe, não é permitido adicionar a matrícula com a mesma referência
====Exemplo====
=====Requisição=====
{"cpf_cnpj":2865474325,"codigoIntegracao":"SA-KJ-AD-NB","codigoMatriculaUnico":"201254", "codigoUnidade":"1","numeroSerieDeMatricula":1,"valor":1000.0,"quantidadeParcelas":1,"formaPagamento":"DINHEIRO"}
=====Resposta=====
=====Resposta=====
"acao": "Manutenção OK",
{
"dados": {
"pagamentoCartao": false,
"cpf_cnpj": 2865474325,
"codigoIntegracao": "SA-KJ-AD-NB",
"dados": [
"codigoMatriculaUnico": "201254",
{
"codigoUnidade":1,
"tituloSituacaoRemote": "ATRASADO",
"numeroSerieDeMatricula": 1,
"dataVencimento": "30/07/2021",
"valor": 1000.0,
"nomeSacado": "Luíza da Silva",
"quantidadeParcelas": 1,
"numeroDocumento": 430114,
"formaPagamento": "DINHEIRO", },
"valorDocumento": 1400.02
"statusProcessamento": "OK",
},
"response": "ACCEPTED",
{
"acao": "Manutenção OK"
}
===Financeiro: Criação de título na matrícula (Titulo)===
Usada na API de matrícula do aluno. Cada título deve ser adicionado na API da Matrícula do aluno. A API de matrículas foi alterada para permitir incluir títulos na alteração. Com isso, será possível adicionar novos títulos para matrículas já existentes, desde que o código "nosso número" já não esteja associado a outro títulos no sistema gestão escolar.
{| class="wikitable"
|'''Atributo'''
|'''Descrição'''
|Tipo
|Mínimo
|Máximo
|-
|'''dataVencimento'''
|Data de vencimento do título
|S
|10
|10
|-
|'''nossoNumero'''
|Número gerado pelo sistema externo que criou o título e que deve ser compartilhado com o Gestão Escolar para que cada interação funcione de forma correta
|S
|1
|50
|-
|'''valorDocumento'''
|Valor que representa o título
|N
|
|
|}
===Financeiro: Alteração de títulos===
Método: Post
(base)/gestaoescolar/services/financeiro/rest/titulo
Ao fazer um POST com indicando o campo de integração (Nosso número) , o valor do documento e a data de vencimento o Web Service irá fazer alteração dos campos correspondentes no boleto já gerado durante a fase da matricula do aluno permitindo assim que os dados desses campos fiquem sincronizados entre os sistemas.
{| class="wikitable"
|'''Atributo'''
|'''Descrição'''
|Tipo
|Mínimo
|Máximo
|-
|'''dataVencimento'''
|Data de vencimento do título
|S
|10
|10
|-
|'''nossoNumero'''
|Número gerado pelo sistema externo que criou o título e que deve ser compartilhado com o Gestão Escolar para que cada interação funcione de forma correta
|S
|1
|50
|-
|'''valorDocumento'''
|Valor que representa o título
|N
|
|
|}
'''Respostas esperadas'''
Status 200: Status Processamento: OK
Status 417: Status Processamento: TITULO_NAO_EXISTE (Quando o título informado não existe)
tatus 417: Status Processamento: ERRO: Erro genérico de negócio
Status 500: Status Processamento: ERRO
====Exemplo====
=====Requisição=====
Body:
{"nossoNumero":"58745876","valorDocumento":"1100.0", "dataVencimento":"11/07/2021"}
=====Resposta=====
{
"acao": "Manutenção OK",
"dados": {
"nomeSacado": "Aluno teste",
"numeroDocumento": 8597757,
"valorAbatimentoConcedido": 0.0,
"valorDescontoConcedido": 0.0,
"valorDespesaCobranca": 0.0,
"valorDocumento": 1100.0,
"valorLiquido": 0.0,
"valorMoraMulta": 0.0,
"valorOutrasDespesas": 0.0,
"valorOutrosCreditos": 0.0,
"dataVencimento": "10/07/2021",
"nossoNumero": "58745876"
},
"response": "OK",
"statusProcessamento": "OK"
}
===Financeiro: Baixa Título.===
Método: Post
(base)/gestaoescolar/services/financeiro/rest/titulo
{| class="wikitable"
|'''Atributo'''
|'''Descrição'''
|Tipo
|Mínimo
|Máximo
|-
|'''nossoNumero'''
|Número gerado pelo sistema interno que criou o título e que deve ser compartilhado com o Gestão Escolar para que cada interação funcione de forma correta
|S
|1
|50
|-
|'''formaPagamento'''
|Forma de pagamento para execução da baixa.
Valores válidos:
DINHEIRO, CHEQUE, C_CREDITO,C_DEBITO, BOLETO, DEB_AUTOMATICO,TRANSFERENCIA, DOC,OUTRO_BAIXA_ADM,DEPOSITO,DUPLICADA, FIES, PREFEITURA,PROUNI, FOLHA_DE_PGTO, CHEQUE_PRE,PAGAMENTO_ONLINE, PERMUTA, PIX
|S
|3
|20
|-
|'''dataOcorrencia'''
|Data de aconteceu a baixa do título, essa data será usada como referência pela baixa no gestão escolar e deve ser incluída,
|S
|10
|10
|-
|'''valorPagamento'''
|Valor do pagamento que deve ser executado no gestão escolar
|N
|
|
|-
|'''dataVencimento'''
|Data de vencimento do título que está em processo de baixa
|S
|10
|10
|-
|'''valorDocumento'''
|Valor do documento original que está em processo de baixa
|N
|
|
|}
A diferença entre as duas APIs acima é o campo "valorPagamento", caso ele seja informado será obrigatório ter os dados de forma de pagamento e data da ocorrência. Caso não seja informado o valor do pagamento, será feita a tentativa de alterar o titulo com o valor do campo valorDocumento ou dataVencimento.
'''Respostas esperadas'''
Status 200: Status Processamento: OK
Status 417: Status Processamento: TITULO_JA_CANCELADO (Quando tenta cancelar um titulo que já foi cancelado)
Status 417: Status Processamento: TITULO_JA_BAIXADO (Quando tenta cancelar um titulo que já foi baixado)
Status 417: Status Processamento: TITULO_NAO_EXISTE (Quando o título informado não existe)
tatus 417: Status Processamento: ERRO: Erro genérico de negócio
Status 500: Status Processamento: ERRO
====Exemplo====
=====Requisição=====
Body:
{"nossoNumero":"58745876","formaPagamento":"BOLETO","valorPagamento":1100.0,"dataOcorrencia":"11/06/2021"}
=====Resposta=====
{
"acao": "Manutenção OK",
"dados": {
"formaPagamento": "BOLETO",
"nomeSacado": "Aluno teste",
"numeroDocumento": 8597757,
"valorAbatimentoConcedido": 0.0,
"valorDescontoConcedido": 0.0,
"valorDespesaCobranca": 0.0,
"valorDocumento": 1000.0,
"valorLiquido": 0.0,
"valorMoraMulta": 0.0,
"valorOutrasDespesas": 0.0,
"valorOutrosCreditos": 0.0,
"valorPagamento": 1100.0,
"dataOcorrencia": "11/06/2021",
"nossoNumero": "58745876"
},
"response": "OK",
"statusProcessamento": "OK"
}
===Financeiro: Cancela Título.===
Método: Delete
(base)/gestaoescolar/services/financeiro/rest/titulo
Executa o cancelamento do título
{| class="wikitable"
|'''Atributo'''
|'''Descrição'''
|Tipo
|Mínimo
|Máximo
|-
|'''nossoNumero'''
|Número gerado pelo sistema interno que criou o título e que deve ser compartilhado com o Gestão Escolar para que cada interação funcione de forma correta
|S
|1
|50
|}
====Respostas esperadas====
Status 200: Status Processamento: OK
Status 417: Status Processamento: TITULO_JA_CANCELADO (Quando tenta cancelar um titulo que já foi cancelado)
Status 417: Status Processamento: TITULO_JA_BAIXADO (Quando tenta cancelar um titulo que já foi baixado)
Status 417: Status Processamento: TITULO_NAO_EXISTE (Quando o título informado não existe)
tatus 417: Status Processamento: ERRO: Erro genérico de negócio
Status 500: Status Processamento: ERRO
====Exemplo====
=====Requisição=====
Param:
nossoNumero=[numero]
=====Resposta=====
{
"acao": "Manutenção OK",
"dados": {
"nomeSacado": "Aluno teste",
"numeroDocumento": 8597756,
"valorAbatimentoConcedido": 0.0,
"valorDescontoConcedido": 0.0,
"valorDespesaCobranca": 0.0,
"valorDocumento": 1000.0,
"valorLiquido": 0.0,
"valorMoraMulta": 0.0,
"valorOutrasDespesas": 0.0,
"valorOutrosCreditos": 0.0,
"nossoNumero": "58745875"
},
"response": "OK",
"statusProcessamento": "OK"
}
===Financeiro: Consulta Títulos.===
Método: GET
(base)/gestaoescolar/services/financeiro/rest/titulo
Executa a consulta determinados do título
{| class="wikitable"
|'''Atributo'''
|'''Descrição'''
|Tipo
|Mínimo
|Máximo
|-
|'''skumatricula'''
|Identificador único da matrícula (padrão) EAD
|S
|1
|
|-
|'''idmatricula'''
|Identifcador interno da matricula
|N
|
|11
|-
|'''cpf'''
|CPF do aluno, irá trazer todos os títulos relacionados
|N
|
|11
|-
|'''rmaluno'''
|Código de RM (registro de matricula) do aluno, só aplicado no filtro se não tiver uma idmatricula informado
|S
|
|
|-
|'''codigocurso'''
|Código do curso, só aplicado quando o rmaluno é informado no filtro
|S
|
|
|-
|'''exibecancelados'''
|Exibe ou não os títulos cancelados , padrão false, informe true para ligar o parâmetro
|S
|
|
|}
Use o parâmetro skumatricula, idinternomatricula ou cpf, caso informe os três, será usado o skumatricula como
padrão e se localizar uma matrícula para o id informado irá retornar os títulos ligados a ela, usando o cpf
irá retornar os títulos localizados para o aluno para qualquer matrícula.
O parâmetro skumatricula é referene ao código da matrícula feito em um sistema externo EAD que está ligado ao gestão escolar, ao informar esse código
será retornada apenas as títulos referentes a essa matrícula. Se passar o idmatricula, é referente ao identificador interno do Gestão Escolar, utilize a API de consultas de matrículas para obter esse código para usar aqui e informado esse parâmetro será carregado os títulos referentes a essa matrícula.
No caso, o CPF do aluno, quando informado, vai pegar todos os títulos, de qualquer matrícula, que esteja associado ao CPF do aluno
====Respostas esperadas====
Status 200: Status Processamento: OK
Status 500: Status Processamento: ERRO
====Exemplo====
=====Requisição=====
Param:
cpf=[numero] ou skumatricula=[numero], exibecancelados=[texto]
=====Resposta=====
"acao": "Manutenção OK",
"dados": [
{
"tituloSituacaoRemote": "ATRASADO",
"dataVencimento": "30/07/2021",
"codigoIntegracao": "SKU_TESTE",
"codigoMatriculaUnico": "UYJA_HAHHS",
"nomeSacado": "Luíza da Silva",
"numeroDocumento": 430114,
"valorDocumento": 1400.02
},
{
"tituloSituacaoRemote": "PENDENTE",
"codigoIntegracao": "SKU_TESTE",
"codigoMatriculaUnico": "UYJA_HAHHS",
"dataVencimento": "30/08/2021",
"nomeSacado": "Luíza da Silva",
"numeroDocumento": 430092,
"valorDocumento": 1400.02
}
],
"response": "OK",
"statusProcessamento": "OK"
}
===Financeiro: Consulta Títulos alterado no período===
Método: GET
(base)/gestaoescolar/services/financeiro/rest/tituloalteradosperiodo
Executa a consulta determinados do título que foram alterados no período
{| class="wikitable"
|'''Atributo'''
|'''Descrição'''
|Tipo
|Mínimo
|Máximo
|-
|'''inicio'''
|Data de inicio da consulta
|S
|10
|10
|-
|'''fim'''
|Data fim da consulta
|S
|10
|10
|}
Atenção: O intervalo de datas permitido para consulta é de no máximo 7 dias. Ao não informar o início, caso o fim tenha data,será considerado a mesma data para início e vice versa. Caso as duas datas sejam nulas/vazias, será considerado o dia atual em ambas.
====Respostas esperadas====
Status 200: Status Processamento: OK
Status 417: Status Processamento: ERRO , caso o intervalo de datas informado seja maior do que 7 dias
Status 500: Status Processamento: ERRO
====Exemplo====
=====Requisição=====
Param:
cpf=[numero] ou skumatricula=[numero], exibecancelados=[texto]
=====Resposta=====
"acao": "Manutenção OK",
"dados": [
{
"tituloSituacaoRemote": "ATRASADO",
"dataVencimento": "30/07/2021",
"nomeSacado": "Luíza da Silva",
"pagamentoTerceiroCodigoExterno": "55848848",
"numeroDocumento": 430114,
"valorDocumento": 1400.02
},
{
"tituloSituacaoRemote": "PENDENTE",
"dataVencimento": "30/08/2021",
"nomeSacado": "Luíza da Silva",
"pagamentoTerceiroCodigoExterno": "55848848",
"numeroDocumento": 430092,
"valorDocumento": 1400.02
}
],
"response": "OK",
"statusProcessamento": "OK"
}
===Controle de acesso: Envio de eventos de entrada e saída===
Método: POST
(base)/gestaoescolar/services/controleacesso/rest/add
Insere registros de entrada e saída para alunos. Deve ser enviado um array com 1 ou mais registros.
'''<u>Importante: Enviar os eventos na ordem certa, ou seja, ordenado por data/hora. Não pode enviar primeiro a SAÍDA e depois a ENTRADA. Sempre ordenar pela data/hora crescente para enviar.</u>'''
{| class="wikitable"
|'''Atributo'''
|'''Descrição'''
|Tipo
|Mínimo
|Máximo
|-
|'''dataHoraOcorrencia'''
|Data e hora do evento. Formato: dd/mm/yyyy HH:mm
|S
|16
|16
|-
|'''descricao'''
|Descrição a ser gravada na ficha do aluno para esse evento. Exemplo: "Registrado por reconhecimento facial"
|S
|1
|20
|-
|'''ra'''
|Deve ter a String exata que representa a Registro de Matrícula do aluno (rm)
|S
|1
|255
|-
|'''tipoAcessos'''
|Informar "E" para entrada ou "S" para saída
|S
|1
|1
|}
Exemplo de request:
[{
"dataHoraOcorrencia": "23/08/2022 13:20",
"descricao": "Registrado por reconhecimento facial",
"ra": "1655",
"tipoAcessos": "S"
},
{
"dataHoraOcorrencia": "23/08/2022 13:13",
"descricao": "Registrado por reconhecimento facial",
"ra": "2726",
"tipoAcessos": "E"
}
]
----
----
----
----
[[Category:GestaoEscolar]]
[[Category:GestaoEscolar]]
[[Category:API]]
[[Category:API]]
