Mudanças

Ir para navegação Ir para pesquisar

Gestão Escolar - API de integração (ver código-fonte)

Edição das 12h55min de 23 de fevereiro de 2024

22 646 bytes adicionados ,  23 fevereiro
→‎Resposta
Linha 75: Linha 75:  
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)====
Linha 185: Linha 185:  
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)====
Linha 246: Linha 246:  
|}
 
|}
   −
====Respostas esperadas====
+
====ReceitaSerie:====
−
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"
 
{| class="wikitable"
 
|'''Atributo'''
 
|'''Atributo'''
Linha 259: Linha 253:  
|Tamanho
 
|Tamanho
 
|-
 
|-
−
|id
+
|codigoContaContabil
−
|Identificador interno GE
+
|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
 
|
 
|
 
|-
 
|-
−
|codigoIntegracaoCurso
+
|numeroParcelasSugerido
−
|Código  identificador do Curso
+
|Número de parcelas que será sugerido no momento que uma receita estiver em processo de inclusão para a série
−
|Texto
+
|Número
−
|255
+
|
 
|-
 
|-
−
|codigoUnidade
+
|numeroParcelasMaximo
−
|Código  da unidade de ensino que o curso pertence.
+
|Número de parcelas máximo permitido no momento que uma receita estiver em processo de inclusão para a série
 
|Número
 
|Número
 
|
 
|
 
|-
 
|-
−
|descricaoUnidade
+
|obrigatorio
−
|Descrição com o nome da unidade de ensino
+
|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
 +
|Boleano
 +
|
 +
|}
 +
 
 +
====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
 +
|-
 +
|codigoIntegracaoCurso
 +
|Código  identificador do Curso
 +
|Texto
 +
|255
 +
|-
 +
|codigoUnidade
 +
|Código  da unidade de ensino que o curso pertence.
 +
|Número
 +
|
 +
|-
 +
|descricaoUnidade
 +
|Descrição com o nome da unidade de ensino
 
|Texto
 
|Texto
 
|40
 
|40
Linha 308: Linha 346:  
|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
 
|}
 
|}
   Linha 315: Linha 358:  
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)====
Linha 435: Linha 478:  
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)====
Linha 475: Linha 518:  
|cpf
 
|cpf
 
|Deve  ter o valor numérico exato do CPF do aluno
 
|Deve  ter o valor numérico exato do CPF do aluno
 +
|-
 +
|
 +
|cpf_cnpjRespFin
 +
|C.P.F ou C.N.PJ do responsável financeiro.
 
|-
 
|-
 
|
 
|
Linha 506: Linha 553:  
|-
 
|-
 
|id
 
|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
 
|
 
|
Linha 761: Linha 808:  
|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:====
Linha 823: Linha 880:  
|}
 
|}
   −
==APIS para manutenção da base de dados==
+
====PessoaAutorizada:====
−
 
  −
===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"
 
{| class="wikitable"
 
|'''Atributo'''
 
|'''Atributo'''
 
|'''Descrição'''
 
|'''Descrição'''
 
|Tipo
 
|Tipo
−
|Mínimo
+
|Tamanho
−
|Máximo
   
|-
 
|-
−
|'''sigla'''
+
|nome
−
|Código  identificador do Curso
+
|Nome da Pessoa
−
|S
+
|Texto
−
|1
+
|
−
|15
   
|-
 
|-
−
|'''codigoUnidade'''
+
|rg
−
|Código da unidade de ensino que o curso pertence. Fixo "1"
+
|RG com número da pessoa autorizada
−
|N
+
|Texto
−
|1
+
|
−
|3
   
|-
 
|-
−
|'''nome'''
+
|parentesco
−
|Descrição do curso
+
|descrição com o parentesco da pessoa autorizada
−
|S
+
|Texto
−
|1
+
|
−
|70
   
|-
 
|-
−
|'''itemServico'''
+
|cpf
−
|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
+
|CPF da pessoa autorizada a retirar
−
|S
+
|Texto
−
|4
+
|
−
|9
+
|}
 +
 
 +
===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)====
 +
{| class="wikitable"
 +
|Obrigatório
 +
|Campo
 +
|Descrição
 
|-
 
|-
−
|'''codigoIntegracao'''
+
|Sim
−
|Código único de integração,  será a chave entre os diferentes sistemas
+
|inicio
−
|S
+
|Data de inicio considerando o data de faturamento da movimentação financeira no formato dd/MM/aaaa
−
|1
  −
|255
   
|-
 
|-
−
|'''modalidadeCurso'''
+
|Sim
−
|‘EAD’  fixo
+
|fim
−
|S
+
|Data de termino considerando o data de faturamento da movimentação financeira  no formato dd/MM/aaaa
−
|1
  −
|30
   
|-
 
|-
−
|'''naturezaOperacao'''
+
|
−
|Natureza de operação será usada na geração das notas fiscais
+
|tipPesquisaData
−
Valores válidos:
+
|Define qual o tipo de pesquisa será realizada nas datas
 +
O padrão é '''VENCIMENTO''', que irá filtrar pela data de vencimento dos títulos
   −
CANCELADO("Cancelado"),
+
'''FATURAMENTO''', que irá filtrar pela data de faturamento
   −
EXIGIBILIDADE_SUSPENSAO_DECISAO_JUDICAL(
+
'''PAGAMENTO''', que irá filtrar pela data de pagamento dos títulos, o que considera apenas títulos já baixados
   −
       "Exigibilidade por suspensão de decisão judicial - Válido até 22/02/2015"),
+
Qualquer outro valor não irá retornar dados
 +
|-
 +
|
 +
|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
 +
|-
 +
|
 +
|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
 +
|}
   −
EXIGIBILIDADE_SUSPENSAO_DECISAO_JUDICAL_2(
+
====Respostas esperadas====
 +
Status 200: : OK
   −
       "Exigibilidade por suspensão de decisão judicial"),
+
Status 417: : Caso não seja informado o código da unidade de negócio e a descrição do período letivo
   −
EXIGIBILIDADE_SUSPENSAO_PROCEDIMENTO_ADM(
+
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado
−
 
+
{| class="wikitable"
−
       "Exigibilidade por suspensão de procedimento administrativo - Válido até 22/02/2015"),
+
|'''Atributo'''
−
 
+
|'''Descrição'''
−
EXIGIBILIDADE_SUSPENSAO_PROCEDIMENTO_ADM_2(
+
|Tipo
−
 
+
|Tamanho
−
       "Exigibilidade por suspensão de procedimento administrativo"),
+
|-
−
 
+
|mes
−
EXIGIBILIDADE_SUSPENSAO_TRIBUTADO_FORA_MUNICIPIO(
+
|Representação numérica com o mês que foi contabilizado (Exemplo: janeiro = 1)
−
 
+
|Número
−
       "Tributado fora do Munícipio, porém Exigibilidade Suspensa - Válido a partir de 23/02/2015"),
+
|
−
 
+
|-
−
EXIGIBILIDADE_SUSPENSAO_TRIBUTADO_MUNICIPIO(
+
|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
 +
|
 +
|
 +
|}
   −
       "Tributado no Munícipio, porém Exigibilidade Suspensa - Válido a partir de 23/02/2015"),
+
=====DadosTitulos:=====
−
 
+
{| class="wikitable"
−
EXPORTACAO( "Exportação"),
+
|'''Atributo'''
−
 
+
|'''Descrição'''
−
EXPORTACAO_SERVICO(
+
|Tipo
−
 
+
|Tamanho
−
       "Exportação de serviços - Válido a partir de 23/02/2015"),
+
|-
−
 
+
|nome
−
EXTRAVIADO("Extraviado - Válido até 22/02/2015"),
+
|Nome da pessoa associada ao título (responsável pelo pagamento)
−
 
+
|Texto
−
IMUNE("Imune - Válido até 22/02/2015"),
+
|70
−
 
+
|-
−
IMUNIDADE("Imunidade"),
+
|dataDePagamento
−
 
+
|Data que o pagamento do título foi efetivado
−
ISENCAO("Isenção - Válido até 22/02/2015"),
+
|Texto
−
 
+
|10
−
ISENCAO_ATUAL("Isenção"),
+
|-
−
 
+
|dataFaturamento
−
MICRO_EMPREENDEDOR_INDIVIDUAL("Micro Empreendedor Individual (MEI)"),
+
|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
−
SIMPLES("Simples Nacional"),
+
|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
 +
|
 +
|}
   −
TRIBUTACAO_FORA_MUNICIPIO("Tributação fora do munipio"),
+
===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:
   −
TRIBUTACAO_MUNICIPIO("Tributação no municipio"),
+
*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
   −
TRIBUTADO_FORA_MUNICIPIO_IMUNE()
+
Método: GET
   −
       "Tributado fora do município, porém Imune - Válido a partir de 23/02/2015"),
+
(base)/gestaoescolar/services/enturmamento/rest/aluno
   −
TRIBUTADO_FORA_MUNICIPIO_ISENTO(
+
====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;
   −
       "Tributado fora do município, porém Isento - Válido a partir de 23/02/2015"),
+
-MICROSOFT_TEAMS;
−
 
  −
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
  −
|1
  −
|50
   
|}
 
|}
    
====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  500:  Status Processamento: ERRO
+
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado
−
 
+
{| class="wikitable"
−
====Exemplo:====
+
|+
−
 
+
!Atributo
−
=====Requisição=====
+
!Descrição
−
{"sigla":"Curso","codigoUnidade":1,"nome":"Curso teste","itemServico":"545454","codigoIntegracao":"SA-KJ-AD-NB","modalidadeCurso":"EAD"}
+
!Tipo
−
 
+
!Tamanho
−
=====Resposta=====
+
|-
−
{
+
|CURSO_CODIGO
−
 
+
|Código do curso
−
   "dados": {
+
|Texto
−
 
+
|15
−
       "sigla": "Curso",
+
|-
−
 
+
|CURSO_ID
−
"codigoUnidade":1,
+
|Identificador do curso
−
 
+
|Número
−
       "nome": "Curso teste",
+
|
−
 
+
|-
−
       "itemServico": "545454",
+
|CURSO_NOME
−
 
+
|Nome do curso
−
       "codigoIntegracao": "SA-KJ-AD-NB",
+
|Texto
−
 
+
|70
−
       "modalidadeCurso": "EAD"
+
|-
−
 
+
|DISCIPLINA_CODIGO
−
   },
+
|Identificador da disciplina
−
 
+
|Número
−
   "statusProcessamento": "OK",
+
|
−
 
+
|-
−
   "response": "ACCEPTED",
+
|DISCIPLINA_NOME
−
 
+
|Nome da disciplina
−
   "acao": "Manutenção OK"
+
|Texto
−
 
+
|200
−
}
+
|-
−
 
+
|IE_CODIGO
−
===Manutenção de alunos===
+
|Código da instituição de ensino fornecido pelo portal externo
−
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.
+
|Texto
−
 
+
|
−
Método: Post
+
|-
−
 
+
|IE_ID
−
(base)/gestaoescolar/services/aluno/rest/responsavelfinanceiro
+
|Identificado da instituição de ensino fornecido pelo portal externo
−
 
+
|Texto
−
====Body====
+
|
−
{| class="wikitable"
+
|-
−
|'''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
 +
|
 
|-
 
|-
−
|'''nome'''
+
|SERIE_CODIGO
−
|Nome do aluno.
+
|Código para a série concatenando código do curso e seqência da série no curso
−
|S
+
|Texto
−
|1
+
|
 +
|-
 +
|SERIE_ID
 +
|Identificador da série
 +
|Número
 +
|
 +
|-
 +
|SERIE_NOME
 +
|Nome da série
 +
|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
   
|-
 
|-
−
|'''cpf'''
+
|TURMA_DISCIPLINA_CODIGO
−
|Sequencia numérica com o CPF do aluno Ex. 65696655565
+
|Código que associa a turma com a disciplina no quadro curricular
−
|N
+
|Número
−
|11
+
|
−
|11
   
|-
 
|-
−
|'''email'''
+
|TURMA_ID
−
|Email  do aluno Ex: aluno@aluno.com.br
+
|Identificador da turma
−
|S
+
|Número
−
|>1
+
|
−
|255
   
|-
 
|-
−
|'''enderecoBairro'''
+
|TURMA_NOME
−
|Bairro do end residencial do aluno Ex. vila didi
+
|Nome da turma
−
|S
+
|Texto
−
|1
+
|65
−
|60
   
|-
 
|-
−
|'''enderecoCep'''
+
|ALUNO_RA
−
|CEP  do end residencial do aluno Ex. 13203320
+
|RM do aluno
−
|S
+
|Texto
−
|8
  −
|8
  −
|-
  −
|'''enderecoCidade'''
  −
|Cidade do end residencial do aluno Ex. jundiai
  −
|S
  −
|1
   
|20
 
|20
 
|-
 
|-
−
|'''enderecoComplemento'''
+
|ALUNO_ID
−
|Complemento  do end residencial do aluno Ex. casa
+
|Identificador do aluno
−
|S
+
|Número
−
|0
+
|
−
|60
   
|-
 
|-
−
|'''enderecoEstado'''
+
|ALUNO_NOME
−
|Estado do end residencial do aluno Ex. SP Max 2 caracteres  deve ser a sigla correspondente ao Estado
+
|Nome do aluno
−
|S
+
|Texto
−
|2
+
|70
−
|2
   
|-
 
|-
−
|'''enderecoLogradouro'''
+
|ALUNO_EMAIL
−
|Logradouro  do end residencial do aluno Ex. rua guapore
+
|E-mail do aluno para acesso ao portal
−
|S
+
|Texto
−
|1
+
|255
−
|60
   
|-
 
|-
−
|'''enderecoNumero'''
+
|ALUNO_CPF
−
|Número do end residencial do aluno Ex. 521
+
|CPF do aluno
−
|S
+
|Número
−
|0
+
|
−
|7
   
|-
 
|-
−
|'''nascimento'''
+
|RESP_PED_NOME
−
|Date com a data de nascimento do aluno dd/MM/yyyy
+
|Nome do responsável pedagógico
−
|S
+
|Texto
−
|10
+
|70
−
|10
   
|-
 
|-
−
|'''rg'''
+
|RESP_PED_EMAIL
−
|RG  do aluno Ex: 584245999
+
|E-mail pessoal do responsável pedagógico
−
|S
+
|Texto
−
|>1
+
|255
−
|25
+
|}
 +
 
 +
===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
 
|-
 
|-
−
|'''sexo'''
+
|Sim
−
|Indicador do gênero do aluno Ex MASCULINO.
+
|portal
 +
|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;
 +
|}
 +
 
 +
====Respostas esperadas====
 +
Status 200: : OK
 +
 
 +
Status 417: : Caso não seja informado o portal ou o mesmo não seja cadastrado na escola
   −
MASCULINO/FEMININO/NAODECLARADO
+
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado
−
|S
+
{| class="wikitable"
−
|8
+
|+
 +
!Atributo
 +
!Descrição
 +
!Tipo
 +
!Tamanho
 +
|-
 +
|CURSO_CODIGO
 +
|Código do curso
 +
|Texto
 
|15
 
|15
 
|-
 
|-
−
|'''nacionalidade'''
+
|CURSO_ID
−
|Nacionalidade do aluno
+
|Identificador do curso
−
|S
+
|Número
−
|0
+
|
−
|30
   
|-
 
|-
−
|'''filiacao1'''
+
|CURSO_NOME
−
|Filiação 1 do aluno (Detalhes tabela pessoa)
+
|Nome do curso
−
|PessoaRemote
+
|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
 
|
 
|
 +
|-
 +
|IE_NOME
 +
|Nome da instituição de ensino fornecido pelo portal externo
 +
|Texto
 
|
 
|
 
|-
 
|-
−
|'''filiacao2'''
+
|PERIODO_CODIGO
−
|Filiação 2 do aluno (Detalhes tabela pessoa)
+
|Identificador do período letivo
−
|PessoaRemote
+
|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
−
====Respostas esperadas====
+
|Número
−
Status 200: Status Processamento: OK
+
|
−
 
+
|-
−
Status 417: Status Processamento: ERRO, JACADASTRADO
+
|SERIE_NOME
−
 
+
|Nome da série
−
Status  500:  Status Processamento: ERRO
+
|Texto
−
 
+
|70
−
====Exemplo====
+
|-
−
 
+
|TURMA_CODIGO
−
=====Requisição=====
+
|Replica o nome da turma
−
{"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"}
+
|Texto
−
 
+
|65
−
=====Resposta=====
+
|-
−
{
+
|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
 +
|
 +
|}
   −
   "dados": {
+
===Cadastrar chave do aluno===
 +
Realiza a atualização no perfil do aluno cadastrando a chave de acesso para aquele portal.
   −
       "celular": "11998465521",
+
Método: POST
   −
       "cpf": 2865474325,
+
(base)/gestaoescolar/services/chavePortal/rest/aluno
   −
       "email": "wescleyfcosta@gmail.com",
+
====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;
   −
       "enderecoBairro": "vila didi",
+
-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:'''
   −
       "enderecoCep": "13203320",
+
{
   −
       "enderecoCidade": "jundiai",
+
   "portal":"GOOGLE_FOR_EDUCATION",
   −
       "enderecoComplemento": "casa",
+
   "atualizar":[
   −
       "enderecoEstado": "SP",
+
       {
   −
       "enderecoLogradouro": "rua guapore",
+
           "chave": "alu3@email.com",
   −
       "enderecoNumero": "521",
+
           "id": 5
   −
       "nascimento": 319518000000,
+
       }
   −
       "nome": "wescley",
+
   ]
   −
       "rg": "584245999",
+
}
   −
       "sexo": "MASCULINO"
+
====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.
   −
   "statusProcessamento": "OK",
+
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado
   −
   "response": "ACCEPTED",
+
===Cadastrar chave do professpr===
 +
Realiza a atualização no perfil do professor cadastrando a chave de acesso para aquele portal.
   −
   "acao": "Manutenção OK"
+
Método: POST
   −
}
+
(base)/gestaoescolar/services/chavePortal/rest/professor
   −
Validações possíveis:
+
====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:'''
   −
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
+
   "portal":"GOOGLE_FOR_EDUCATION",
   −
  - O cadastro do aluno não está mais ativo
+
   "atualizar":[
   −
  *- O formato do CPF é inválido
+
       {
   −
  - Informou uma senha que não está dentro das regras definidas na configuração
+
           "chave": "alu3@email.com",
   −
  - 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)
+
           "id": 5
   −
  * - 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===
+
====Respostas esperadas====
−
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.
+
Status 200: : OK
   −
Método: Post
+
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.
   −
(base)/gestaoescolar/services/matricula/rest/add
+
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado
 +
==APIS para manutenção da base de dados==
   −
====Body====
+
===Manutenção de cursos===
−
{| class="wikitable"
+
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'''
 
|'''Atributo'''
 
|'''Descrição'''
 
|'''Descrição'''
Linha 1 201: Linha 1 522:  
|Máximo
 
|Máximo
 
|-
 
|-
−
|'''cpf_cnpj'''
+
|'''sigla'''
−
|CPF do aluno que será gerada a matrícula, apenas  numeros
+
|Código  identificador do Curso
−
|N
  −
|11
  −
|11
  −
|-
  −
|'''codigoIntegracao'''
  −
|Código de integração para um Curso existente
   
|S
 
|S
 
|1
 
|1
−
|255
+
|15
−
|-
  −
|'''codigoMatriculaUnico'''
  −
|Código de integração para busca de uma matrícula ou  para criar uma nova
  −
|S
  −
|1
  −
|255
   
|-
 
|-
 
|'''codigoUnidade'''
 
|'''codigoUnidade'''
Linha 1 225: Linha 1 534:  
|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
−
 
  −
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
  −
|-
  −
|'''origem'''
  −
|Origem da matrícula, como padrão "Plataforma EAD"
   
|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:
   −
Detalhes da api na tabela TituloRemote
+
CANCELADO("Cancelado"),
−
|Titulo
  −
|
  −
|
  −
|}
     −
====Respostas esperadas====
+
EXIGIBILIDADE_SUSPENSAO_DECISAO_JUDICAL(
−
Status 200: Status Processamento: OK
     −
Status 417: Status Processamento: JACADASTRADO (quando existe uma outra matrícula não cancelada no mesmo período letivo)
+
       "Exigibilidade por suspensão de decisão judicial - Válido até 22/02/2015"),
   −
Status 417: Status Processamento: CURSO_NAO_EXISTE (quando o código de integração informado não encontrou um curso correspondente cadastrado)
+
EXIGIBILIDADE_SUSPENSAO_DECISAO_JUDICAL_2(
   −
Status 417: Status Processamento: ALUNO_NAO_EXISTE (quando o C.P.F informado não encontrou um aluno correspondente cadastrado)
+
       "Exigibilidade por suspensão de decisão judicial"),
   −
Status 417: Status Processamento: TITULO_NAO_EXISTE (Quando o título informado não existe)
+
EXIGIBILIDADE_SUSPENSAO_PROCEDIMENTO_ADM(
   −
Status  500:  Status Processamento: ERRO
+
       "Exigibilidade por suspensão de procedimento administrativo - Válido até 22/02/2015"),
   −
====Exemplo====
+
EXIGIBILIDADE_SUSPENSAO_PROCEDIMENTO_ADM_2(
   −
=====Requisição=====
+
       "Exigibilidade por suspensão de procedimento administrativo"),
−
{"cpf_cnpj":2865474325,"codigoIntegracao":"SA-KJ-AD-NB","codigoMatriculaUnico":"201254", "codigoUnidade":"1","numeroSerieDeMatricula":1,"valor":1000.0,"quantidadeParcelas":1,"formaPagamento":"DINHEIRO"}
     −
=====Resposta=====
+
EXIGIBILIDADE_SUSPENSAO_TRIBUTADO_FORA_MUNICIPIO(
−
{
     −
   "dados": {
+
       "Tributado fora do Munícipio, porém Exigibilidade Suspensa - Válido a partir de 23/02/2015"),
   −
       "pagamentoCartao": false,
+
EXIGIBILIDADE_SUSPENSAO_TRIBUTADO_MUNICIPIO(
   −
       "cpf_cnpj": 2865474325,
+
       "Tributado no Munícipio, porém Exigibilidade Suspensa - Válido a partir de 23/02/2015"),
   −
       "codigoIntegracao": "SA-KJ-AD-NB",
+
EXPORTACAO( "Exportação"),
   −
       "codigoMatriculaUnico": "201254",
+
EXPORTACAO_SERVICO(
   −
"codigoUnidade":1,
+
       "Exportação de serviços - Válido a partir de 23/02/2015"),
   −
       "numeroSerieDeMatricula": 1,
+
EXTRAVIADO("Extraviado - Válido até 22/02/2015"),
   −
       "valor": 1000.0,
+
IMUNE("Imune - Válido até 22/02/2015"),
   −
       "quantidadeParcelas": 1,
+
IMUNIDADE("Imunidade"),
   −
       "formaPagamento": "DINHEIRO",   },
+
ISENCAO("Isenção - Válido até 22/02/2015"),
   −
   "statusProcessamento": "OK",
+
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()
   −
   "response": "ACCEPTED",
+
       "Tributado fora do município, porém Imune - Válido a partir de 23/02/2015"),
   −
   "acao": "Manutenção OK"
+
TRIBUTADO_FORA_MUNICIPIO_ISENTO(
   −
}
+
       "Tributado fora do município, porém Isento - Válido a partir de 23/02/2015"),
   −
===Manutenção de Pessoas===
+
TRIBUTADO_MUNICIPIO_IMUNE("Tributado no município, porém Imune - Válido a partir de 23/02/2015"),
−
Usado nos dados do aluno para representar uma filiação.
     −
{| class="wikitable"
+
TRIBUTADO_MUNICIPIO_ISENTO("Tributado no município, porém Isento - Válido a partir de 23/02/2015");
−
|'''Atributo'''
  −
|'''Descrição'''
  −
|Tipo
  −
|Mínimo
  −
|Máximo
  −
|-
  −
|'''nome'''
  −
|Nome do aluno.
  −
|S
  −
|1
  −
|70
  −
|-
  −
|'''celular'''
  −
|Número de telefone celular Ex: 11998465521 ou (11) 99999-9999
  −
|S
  −
|11
  −
|15
  −
|-
  −
|'''cpf'''
  −
|Sequencia numérica com o CPF do aluno Ex. 65696655565
   
|N
 
|N
−
|11
  −
|11
  −
|-
  −
|'''email'''
  −
|Email  do aluno Ex: aluno@aluno.com.br
  −
|S
  −
|>1
  −
|255
  −
|-
  −
|'''enderecoBairro'''
  −
|Bairro do end residencial do aluno Ex. vila didi
  −
|S
   
|1
 
|1
−
|60
+
|50
−
|-
+
|}
−
|'''enderecoCep'''
+
 
−
|CEP  do end residencial do aluno Ex. 13203320
+
====Respostas esperadas====
−
|S
+
Status 200: Status Processamento: OK
−
|8
+
 
−
|8
+
Status 417: Status Processamento: JACADASTRADO. Quando a mesma sigla de curso está cadastrado em mais de um registro.
−
|-
+
 
−
|'''enderecoCidade'''
+
Status  500:  Status Processamento: ERRO
−
|Cidade do end residencial do aluno Ex. jundiai
+
 
−
|S
+
====Exemplo:====
−
|1
+
 
−
|20
+
=====Requisição=====
−
|-
+
{"sigla":"Curso","codigoUnidade":1,"nome":"Curso teste","itemServico":"545454","codigoIntegracao":"SA-KJ-AD-NB","modalidadeCurso":"EAD"}
−
|'''enderecoComplemento'''
+
 
−
|Complemento  do end residencial do aluno Ex. casa
+
=====Resposta=====
−
|S
+
{
−
|0
+
 
−
|60
+
   "dados": {
−
|-
+
 
−
|'''enderecoEstado'''
+
       "sigla": "Curso",
−
|Estado do end residencial do aluno Ex. SP Max 2 caracteres  deve ser a sigla correspondente ao Estado
+
 
−
|S
+
"codigoUnidade":1,
−
|2
+
 
−
|2
+
       "nome": "Curso teste",
−
|-
+
 
−
|'''enderecoLogradouro'''
+
       "itemServico": "545454",
−
|Logradouro  do end residencial do aluno Ex. rua guapore
+
 
−
|S
+
       "codigoIntegracao": "SA-KJ-AD-NB",
−
|1
+
 
−
|60
+
       "modalidadeCurso": "EAD"
−
|-
+
 
−
|'''enderecoNumero'''
+
   },
−
|Número do end residencial do aluno Ex. 521
+
 
−
|S
+
   "statusProcessamento": "OK",
−
|0
+
 
−
|7
+
   "response": "ACCEPTED",
−
|-
+
 
−
|'''nascimento'''
+
   "acao": "Manutenção OK"
−
|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
+
===Manutenção de alunos===
−
|S
+
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.
−
|8
  −
|15
  −
|-
  −
|'''nacionalidade'''
  −
|Nacionalidade do aluno
  −
|S
  −
|0
  −
|30
  −
|}
     −
===Financeiro: Criação de título na matrícula (Titulo)===
+
Método: Post
   −
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.
+
(base)/gestaoescolar/services/aluno/rest/responsavelfinanceiro
    +
====Body====
 
{| class="wikitable"
 
{| class="wikitable"
 
|'''Atributo'''
 
|'''Atributo'''
Linha 1 431: Linha 1 682:  
|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
−
|}
  −
 
  −
===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'''
+
|'''email'''
−
|Data de vencimento do título
+
|Email  do aluno Ex: aluno@aluno.com.br
 
|S
 
|S
−
|10
+
|>1
−
|10
+
|255
 
|-
 
|-
−
|'''nossoNumero'''
+
|'''enderecoBairro'''
−
|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
+
|Bairro do end residencial do aluno Ex. vila didi
 
|S
 
|S
 
|1
 
|1
−
|50
+
|60
 +
|-
 +
|'''enderecoCep'''
 +
|CEP  do end residencial do aluno Ex. 13203320
 +
|S
 +
|8
 +
|8
 
|-
 
|-
−
|'''valorDocumento'''
+
|'''enderecoCidade'''
−
|Valor que representa o título
+
|Cidade do end residencial do aluno Ex. jundiai
−
|N
+
|S
−
|
+
|1
−
|
+
|20
−
|}
+
|-
−
 
+
|'''enderecoComplemento'''
−
'''Respostas esperadas'''
+
|Complemento  do end residencial do aluno Ex. casa
−
 
+
|S
−
Status 200: Status Processamento: OK
+
|0
−
 
+
|60
−
Status 417: Status Processamento: TITULO_NAO_EXISTE (Quando o título informado não existe)
+
|-
−
 
+
|'''enderecoEstado'''
−
tatus 417: Status Processamento: ERRO: Erro genérico de negócio
+
|Estado do end residencial do aluno Ex. SP Max 2 caracteres  deve ser a sigla correspondente ao Estado
−
 
+
|S
−
Status  500:  Status Processamento: ERRO
+
|2
−
 
+
|2
−
====Exemplo====
+
|-
−
 
+
|'''enderecoLogradouro'''
−
=====Requisição=====
+
|Logradouro  do end residencial do aluno Ex. rua guapore
−
Body:
+
|S
−
 
+
|1
−
{"nossoNumero":"58745876","valorDocumento":"1100.0", "dataVencimento":"11/07/2021"}
+
|60
−
 
+
|-
−
=====Resposta=====
+
|'''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.
   −
   "acao": "Manutenção OK",
+
MASCULINO/FEMININO/NAODECLARADO
 +
|S
 +
|8
 +
|15
 +
|-
 +
|'''nacionalidade'''
 +
|Nacionalidade do aluno
 +
|S
 +
|0
 +
|30
 +
|-
 +
|'''filiacao1'''
 +
|Filiação 1 do aluno (Detalhes tabela pessoa)
 +
|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
 +
|}
   −
   "dados": {
+
====Filiação====
 +
Usado nos dados do aluno para representar uma filiação.
   −
       "nomeSacado": "Aluno teste",
+
{| class="wikitable"
−
 
+
|'''Atributo'''
−
       "numeroDocumento": 8597757,
+
|'''Descrição'''
−
 
+
|Tipo
−
       "valorAbatimentoConcedido": 0.0,
+
|Mínimo
−
 
+
|Máximo
−
       "valorDescontoConcedido": 0.0,
+
|-
−
 
+
|'''nome'''
−
       "valorDespesaCobranca": 0.0,
+
|Nome do aluno.
−
 
+
|S
−
       "valorDocumento": 1100.0,
+
|1
−
 
+
|70
−
       "valorLiquido": 0.0,
+
|-
−
 
+
|'''celular'''
−
       "valorMoraMulta": 0.0,
+
|Número de telefone celular Ex: 11998465521 ou (11) 99999-9999
−
 
+
|S
−
       "valorOutrasDespesas": 0.0,
+
|11
−
 
+
|15
−
       "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'''
+
|'''cpf'''
−
|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
+
|Sequencia numérica com o CPF do aluno Ex. 65696655565
 +
|N
 +
|11
 +
|11
 +
|-
 +
|'''email'''
 +
|Email  do aluno Ex: aluno@aluno.com.br
 
|S
 
|S
−
|1
+
|>1
−
|50
+
|255
 
|-
 
|-
−
|'''formaPagamento'''
+
|'''enderecoBairro'''
−
|Forma de pagamento para execução da baixa.  
+
|Bairro do end residencial do aluno Ex. vila didi
−
 
  −
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
 
|S
−
|3
+
|1
−
|20
+
|60
 
|-
 
|-
−
|'''dataOcorrencia'''
+
|'''enderecoCep'''
−
|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,
+
|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
 
|S
−
|10
+
|0
−
|10
+
|60
 
|-
 
|-
−
|'''valorPagamento'''
+
|'''enderecoEstado'''
−
|Valor do pagamento que deve ser executado no gestão escolar
+
|Estado do end residencial do aluno Ex. SP Max 2 caracteres  deve ser a sigla correspondente ao Estado
−
|N
+
|S
−
|
+
|2
−
|
+
|2
−
|}
+
|-
−
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.
+
|'''enderecoLogradouro'''
−
 
+
|Logradouro  do end residencial do aluno Ex. rua guapore
−
'''Respostas esperadas'''
+
|S
−
 
+
|1
−
Status 200: Status Processamento: OK
+
|60
−
 
+
|-
−
Status 417: Status Processamento: TITULO_JA_CANCELADO (Quando tenta cancelar um titulo que já foi cancelado)
+
|'''enderecoNumero'''
−
 
+
|Número do end residencial do aluno Ex. 521
−
Status 417: Status Processamento: TITULO_JA_BAIXADO (Quando tenta cancelar um titulo que já foi baixado)
+
|S
−
 
+
|0
−
Status 417: Status Processamento: TITULO_NAO_EXISTE (Quando o título informado não existe)
+
|7
−
 
+
|-
−
tatus 417: Status Processamento: ERRO: Erro genérico de negócio
+
|'''nascimento'''
−
 
+
|Date com a data de nascimento do aluno dd/MM/yyyy
−
Status  500:  Status Processamento: ERRO
+
|S
−
 
+
|10
−
====Exemplo====
+
|10
−
 
+
|-
−
=====Requisição=====
+
|'''rg'''
−
Body:
+
|RG  do aluno Ex: 584245999
−
 
+
|S
−
{"nossoNumero":"58745876","formaPagamento":"BOLETO","valorPagamento":1100.0,"dataOcorrencia":"11/06/2021"}
+
|>1
 +
|25
 +
|-
 +
|'''sexo'''
 +
|Indicador do gênero do aluno Ex MASCULINO.
   −
=====Resposta=====
+
MASCULINO/FEMININO
−
{
+
|S
 +
|8
 +
|15
 +
|-
 +
|'''nacionalidade'''
 +
|Nacionalidade do aluno
 +
|S
 +
|0
 +
|30
 +
|}
   −
   "acao": "Manutenção OK",
+
====Respostas esperadas====
 +
Status 200: Status Processamento: OK
   −
   "dados": {
+
Status 417: Status Processamento: ERRO, JACADASTRADO
   −
       "formaPagamento": "BOLETO",
+
Status  500:  Status Processamento: ERRO
   −
       "nomeSacado": "Aluno teste",
+
====Exemplo====
   −
       "numeroDocumento": 8597757,
+
=====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"}
   −
       "valorAbatimentoConcedido": 0.0,
+
=====Resposta=====
 +
{
   −
       "valorDescontoConcedido": 0.0,
+
   "dados": {
   −
       "valorDespesaCobranca": 0.0,
+
       "celular": "11998465521",
   −
       "valorDocumento": 1000.0,
+
       "cpf": 2865474325,
   −
       "valorLiquido": 0.0,
+
       "email": "wescleyfcosta@gmail.com",
   −
       "valorMoraMulta": 0.0,
+
       "enderecoBairro": "vila didi",
   −
       "valorOutrasDespesas": 0.0,
+
       "enderecoCep": "13203320",
   −
       "valorOutrosCreditos": 0.0,
+
       "enderecoCidade": "jundiai",
   −
       "valorPagamento": 1100.0,
+
       "enderecoComplemento": "casa",
 +
 
 +
       "enderecoEstado": "SP",
 +
 
 +
       "enderecoLogradouro": "rua guapore",
 +
 
 +
       "enderecoNumero": "521",
 +
 
 +
       "nascimento": 319518000000,
 +
 
 +
       "nome": "wescley",
   −
       "dataOcorrencia": "11/06/2021",
+
       "rg": "584245999",
   −
       "nossoNumero": "58745876"
+
       "sexo": "MASCULINO"
    
   },
 
   },
   −
   "response": "OK",
+
   "statusProcessamento": "OK",
 +
 
 +
   "response": "ACCEPTED",
   −
   "statusProcessamento": "OK"
+
   "acao": "Manutenção OK"
    
}
 
}
   −
===Financeiro: Cancela Título.===
+
Validações possíveis:
−
Método: Delete
     −
(base)/gestaoescolar/services/financeiro/rest/titulo
+
Existem diversas validações internas que podem retornar uma falha ao cadastrar um aluno. São elas:   
   −
Executa o cancelamento do título
+
  - Trocar senha com perfil de autenticação inválido
   −
{| class="wikitable"
+
  - O cadastro do aluno não está mais ativo
−
|'''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====
+
  *- O formato do CPF é inválido
−
Status 200: Status Processamento: OK
     −
Status 417: Status Processamento: TITULO_JA_CANCELADO (Quando tenta cancelar um titulo que já foi cancelado)
+
  - Informou uma senha que não está dentro das regras definidas na configuração
   −
Status 417: Status Processamento: TITULO_JA_BAIXADO (Quando tenta cancelar um titulo que já foi baixado)
+
  - 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)
   −
Status 417: Status Processamento: TITULO_NAO_EXISTE (Quando o título informado não existe)
+
  * - O responsável financeiro for menor que 18 anos
   −
tatus 417: Status Processamento: ERRO: Erro genérico de negócio
+
  * - Quando o endereço residencial do aluno não é fornecido  
   −
Status  500:  Status Processamento: ERRO
+
Os marcados com * são os que podem ocorrer usando essa API
   −
====Exemplo====
+
===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.
   −
=====Requisição=====
+
Método: Post
−
Param:
     −
nossoNumero=[numero]
+
(base)/gestaoescolar/services/matricula/rest/add
   −
=====Resposta=====
+
====Body====
−
{
+
{| class="wikitable"
−
 
+
|'''Atributo'''
−
   "acao": "Manutenção OK",
+
|'''Descrição'''
−
 
+
|Tipo
−
   "dados": {
+
|Mínimo
−
 
+
|Máximo
−
       "nomeSacado": "Aluno teste",
+
|-
−
 
+
|'''cpf_cnpj'''
−
       "numeroDocumento": 8597756,
+
|CPF do aluno que será gerada a matrícula, apenas  numeros
−
 
+
|N
−
       "valorAbatimentoConcedido": 0.0,
+
|11
−
 
+
|11
−
       "valorDescontoConcedido": 0.0,
+
|-
−
 
+
|'''codigoIntegracao'''
−
       "valorDespesaCobranca": 0.0,
+
|Código de integração para um Curso existente
−
 
+
|S
−
       "valorDocumento": 1000.0,
+
|1
−
 
+
|255
−
       "valorLiquido": 0.0,
+
|-
−
 
+
|'''codigoMatriculaUnico'''
−
       "valorMoraMulta": 0.0,
+
|Código de integração para busca de uma matrícula ou  para criar uma nova
−
 
+
|S
−
       "valorOutrasDespesas": 0.0,
+
|1
−
 
+
|255
−
       "valorOutrosCreditos": 0.0,
+
|-
−
 
+
|'''codigoUnidade'''
−
       "nossoNumero": "58745875"
+
|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:
   −
   "response": "OK",
+
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
   −
   "statusProcessamento": "OK"
+
Deixe null caso não seja necessário a baixa durante a inclusão da matrícula
   −
}
+
|S
−
 
+
|3
−
===Financeiro: Consulta Títulos.===
+
|20
−
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'''
+
|'''origem'''
−
|Identificador único da matrícula (padrão) EAD
+
|Origem da matrícula, como padrão "Plataforma EAD"
 
|S
 
|S
 
|1
 
|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
 +
|
 
|
 
|
 
|-
 
|-
−
|'''idmatricula'''
+
|'''notificarAlunoAcessoPortal'''
−
|Identifcador interno da matricula
+
|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)
−
|N
+
|S
−
|
+
|4
−
|11
+
|6
 
|-
 
|-
−
|'''cpf'''
+
|'''periodoLetivo'''
−
|CPF do aluno, irá trazer todos os títulos relacionados
+
|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".
−
|N
  −
|
  −
|11
  −
|-
  −
|'''exibecancelados'''
  −
|Exibe ou não os títulos cancelados , padrão false, informe true para ligar o parâmetro
   
|S
 
|S
−
|
+
|0
−
|
+
|20
 
|}
 
|}
−
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
+
====Respostas esperadas====
 +
Status 200: Status Processamento: OK
   −
irá retornar os títulos localizados para o aluno para qualquer matrícula. 
+
Status 417: Status Processamento: JACADASTRADO (quando existe uma outra matrícula não cancelada no mesmo período letivo)
   −
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
+
Status 417: Status Processamento: CURSO_NAO_EXISTE (quando o código de integração informado não encontrou um curso correspondente cadastrado)
   −
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. 
+
Status 417: Status Processamento: ALUNO_NAO_EXISTE (quando o C.P.F informado não encontrou um aluno correspondente cadastrado)
   −
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
+
Status 417: Status Processamento: TITULO_NAO_EXISTE (Quando o título informado não existe)
   −
====Respostas esperadas====
+
Status  500:  Status Processamento: ERRO
−
Status 200: Status Processamento: OK
+
 
 +
======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}
 +
 
 +
       - 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
 +
 
 +
       - 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.           
 +
 
 +
       - 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}.          
   −
Status  500:  Status Processamento: ERRO
+
        - 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
   −
====Exemplo====
+
uma receita obrigatória cadastrada    
   −
=====Requisição=====
+
        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            
−
Param:
     −
cpf=[numero] ou skumatricula=[numero], exibecancelados=[texto]
+
       Geração dos boletos:       
   −
=====Resposta=====
+
       - Caso a matrícula tenha Tenha o atributo do valor maior que zero, e a modalidade do curso referente ao atributo codigoIntegracao for EAD
−
"acao": "Manutenção OK",
     −
   "dados": [       
+
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:
−
 
+
 
−
           "tituloSituacaoRemote": "ATRASADO",
+
           Erro:  A conta contábil de recebimento não está configurado na parte financeira da série para a receita:           
−
 
+
 
−
           "dataVencimento": "30/07/2021",
+
       - Caso o atributo "titulos" esteja preenchido e a somatória do atributo do titulo chamado valorDocumento não bater com o atributo "valor" do
−
 
+
 
−
           "nomeSacado": "Luíza da Silva",
+
corpo da matrícula.        
−
 
+
 
−
           "numeroDocumento": 430114,
+
          Erro: O valor total informado ({0}) não bate com a somatória de valores de cada parcela ({1})          
−
 
+
 
−
           "valorDocumento": 1400.02
+
       -  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=====
 +
{
 +
 
 +
   "dados": {
 +
 
 +
       "pagamentoCartao": false,
 +
 
 +
       "cpf_cnpj": 2865474325,
 +
 
 +
       "codigoIntegracao": "SA-KJ-AD-NB",
 +
 
 +
       "codigoMatriculaUnico": "201254",
 +
 
 +
"codigoUnidade":1,
 +
 
 +
       "numeroSerieDeMatricula": 1,
 +
 
 +
       "valor": 1000.0,
 +
 
 +
       "quantidadeParcelas": 1,
 +
 
 +
       "formaPagamento": "DINHEIRO",   },
 +
 
 +
   "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"
 +
 
 +
   },
   −
           "tituloSituacaoRemote": "PENDENTE",
+
   {
   −
           "dataVencimento": "30/08/2021",
+
       "dataHoraOcorrencia": "23/08/2022 13:13",
   −
           "nomeSacado": "Luíza da Silva",
+
       "descricao": "Registrado por reconhecimento facial",
   −
           "numeroDocumento": 430092,
+
       "ra": "2726",
   −
           "valorDocumento": 1400.02
+
       "tipoAcessos": "E"
   −
       }
+
   }
   −
   ],
+
]
−
 
  −
   "response": "OK",
  −
 
  −
   "statusProcessamento": "OK"
  −
 
  −
}
   
----
 
----
 
----
 
----
 
[[Category:GestaoEscolar]]
 
[[Category:GestaoEscolar]]
 
[[Category:API]]
 
[[Category:API]]
Wescley
privado
180

edições

Disponível em “http://wiki.ultramax.com.br/mediawiki/index.php/Especial:MobileDiff/10790...15083”

Menu de navegação