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
|Texto
|Texto
|
|
|-
|pessoasAutorizadas
|Pessoas que tem autorização para retirar o Aluno
|PessoaAutorizada
|0..N
|}
|}
====Estado:====
====Estado:====
|Estado da Federação que o aluno mora
|Estado da Federação que o aluno mora
|Estado*
|Estado*
|
|}
====PessoaAutorizada:====
{| class="wikitable"
|'''Atributo'''
|'''Descrição'''
|Tipo
|Tamanho
|-
|nome
|Nome da Pessoa
|Texto
|
|-
|rg
|RG com número da pessoa autorizada
|Texto
|
|-
|parentesco
|descrição com o parentesco da pessoa autorizada
|Texto
|
|-
|cpf
|CPF da pessoa autorizada a retirar
|Texto
|
|
|}
|}
|}
|}
==== DadosTitulos: ====
=====DadosTitulos:=====
{| class="wikitable"
{| class="wikitable"
|'''Atributo'''
|'''Atributo'''
|-
|-
|status
|status
|Situação atual da matrícula
|Situação atual da matrícula
|Texto
|Texto
|30
|30
Status 500: Status Processamento: ERRO
Status 500: Status Processamento: ERRO
====Exemplo====
======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}
"cpf_cnpj": 2865474325,
- O código integração do curso "codigoIntegracao" deve estar associado a algum curso no GE
"codigoIntegracao": "SA-KJ-AD-NB",
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}.
- 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=====
{
"dados": {
"pagamentoCartao": false,
"cpf_cnpj": 2865474325,
"codigoIntegracao": "SA-KJ-AD-NB",
"codigoMatriculaUnico": "201254",
"codigoUnidade":1,
"dados": {
"numeroSerieDeMatricula": 1,
"nomeSacado": "Aluno teste",
"valor": 1000.0,
"numeroDocumento": 8597757,
"quantidadeParcelas": 1,
"valorAbatimentoConcedido": 0.0,
"formaPagamento": "DINHEIRO", },
"statusProcessamento": "OK",
"response": "ACCEPTED",
"acao": "Manutenção OK"
}
}
===Financeiro: Baixa Título.===
===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"
{| class="wikitable"
|Máximo
|Máximo
|-
|-
|'''nossoNumero'''
|'''dataVencimento'''
|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
|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
|S
|1
|1
|50
|50
|-
|-
|'''formaPagamento'''
|'''valorDocumento'''
|Forma de pagamento para execução da baixa.
|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.
|S
{| class="wikitable"
|3
|'''Atributo'''
|20
|'''Descrição'''
|-
|Tipo
|'''dataOcorrencia'''
|Mínimo
|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,
|Máximo
|-
|'''dataVencimento'''
|Data de vencimento do título
|S
|S
|10
|10
|10
|10
|-
|-
|'''valorPagamento'''
|'''nossoNumero'''
|Valor do pagamento que deve ser executado no gestão escolar
|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
|S
|10
|1
|10
|50
|-
|-
|'''valorDocumento'''
|'''valorDocumento'''
|Valor do documento original que está em processo de baixa
|Valor que representa o título
|N
|N
|
|
|
|
|}
|}
'''Respostas esperadas'''
'''Respostas esperadas'''
Status 200: Status Processamento: OK
Status 200: Status Processamento: OK
Status 417: Status Processamento: TITULO_NAO_EXISTE (Quando o título informado não existe)
Status 417: Status Processamento: TITULO_NAO_EXISTE (Quando o título informado não existe)
Body:
Body:
{"nossoNumero":"58745876","formaPagamento":"BOLETO","valorPagamento":1100.0,"dataOcorrencia":"11/06/2021"}
{"nossoNumero":"58745876","valorDocumento":"1100.0", "dataVencimento":"11/07/2021"}
=====Resposta=====
=====Resposta=====
"dados": {
"dados": {
"nomeSacado": "Aluno teste",
"nomeSacado": "Aluno teste",
"valorDespesaCobranca": 0.0,
"valorDespesaCobranca": 0.0,
"valorDocumento": 1000.0,
"valorDocumento": 1100.0,
"valorLiquido": 0.0,
"valorLiquido": 0.0,
"valorOutrosCreditos": 0.0,
"valorOutrosCreditos": 0.0,
"valorPagamento": 1100.0,
"dataVencimento": "10/07/2021",
"nossoNumero": "58745876"
"nossoNumero": "58745876"
}
}
===Financeiro: Cancela Título.===
===Financeiro: Baixa Título.===
Método: Delete
Método: Post
(base)/gestaoescolar/services/financeiro/rest/titulo
(base)/gestaoescolar/services/financeiro/rest/titulo
{| class="wikitable"
{| class="wikitable"
|1
|1
|50
|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.
tatus 417: Status Processamento: ERRO: Erro genérico de negócio
'''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
Status 500: Status Processamento: ERRO
=====Requisição=====
=====Requisição=====
Body:
nossoNumero=[numero]
{"nossoNumero":"58745876","formaPagamento":"BOLETO","valorPagamento":1100.0,"dataOcorrencia":"11/06/2021"}
=====Resposta=====
=====Resposta=====
"dados": {
"dados": {
"formaPagamento": "BOLETO",
"nomeSacado": "Aluno teste",
"nomeSacado": "Aluno teste",
"numeroDocumento": 8597756,
"numeroDocumento": 8597757,
"valorAbatimentoConcedido": 0.0,
"valorAbatimentoConcedido": 0.0,
"valorOutrosCreditos": 0.0,
"valorOutrosCreditos": 0.0,
"nossoNumero": "58745875"
"valorPagamento": 1100.0,
"dataOcorrencia": "11/06/2021",
"nossoNumero": "58745876"
},
},
}
}
===Financeiro: Consulta Títulos.===
===Financeiro: Cancela Título.===
Método: GET
Método: Delete
(base)/gestaoescolar/services/financeiro/rest/titulo
(base)/gestaoescolar/services/financeiro/rest/titulo
Executa a consulta determinados do título
Executa o cancelamento do título
{| class="wikitable"
{| class="wikitable"
|'''Atributo'''
|'''Atributo'''
|Máximo
|Máximo
|-
|-
|'''skumatricula'''
|'''nossoNumero'''
|Identificador único da matrícula (padrão) EAD
|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
|S
|1
|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,
"acao": "Manutenção OK",
"dados": [
"valorDespesaCobranca": 0.0,
"valorDocumento": 1000.0,
"valorLiquido": 0.0,
"valorMoraMulta": 0.0,
"valorOutrasDespesas": 0.0,
"valorOutrosCreditos": 0.0,
"nossoNumero": "58745875"
},
"response": "OK",
"response": "OK",
}
}
===Financeiro: Consulta Títulos alterado no período.===
===Financeiro: Consulta Títulos.===
Método: GET
Método: GET
(base)/gestaoescolar/services/financeiro/rest/tituloalteradosperiodo
(base)/gestaoescolar/services/financeiro/rest/titulo
Executa a consulta determinados do título
{| class="wikitable"
{| class="wikitable"
|'''Atributo'''
|'''Atributo'''
|Máximo
|Máximo
|-
|-
|'''inicio'''
|'''skumatricula'''
|Data de inicio da consulta
|Identificador único da matrícula (padrão) EAD
|S
|S
|10
|1
|10
|
|-
|'''idmatricula'''
|Identifcador interno da matricula
|N
|
|11
|-
|'''cpf'''
|CPF do aluno, irá trazer todos os títulos relacionados
|N
|
|11
|-
|-
|'''fim'''
|'''rmaluno'''
|Data fim da consulta
|Código de RM (registro de matricula) do aluno, só aplicado no filtro se não tiver uma idmatricula informado
|S
|S
|10
|
|10
|
|-
|'''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====
====Respostas esperadas====
Status 200: Status Processamento: OK
Status 200: Status Processamento: OK
Status 500: Status Processamento: ERRO
Status 500: Status Processamento: ERRO
"tituloSituacaoRemote": "ATRASADO",
"tituloSituacaoRemote": "ATRASADO",
"dataVencimento": "30/07/2021",
"dataVencimento": "30/07/2021",
"nomeSacado": "Luíza da Silva",
"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]]
