Burocratas, privado, Administradores
1 692
edições
Mudanças
De UltramaxWiki
Gestão Escolar - API de integração (ver código-fonte)
Edição das 18h55min de 13 de março de 2025
, 13 marçosem sumário de edição
Linha 108:
Linha 108:
Informando o código, irá retornar a série correspondente cadastrada
Informando o código, irá retornar a série correspondente cadastrada
+|-
+|nivelEnsino
+|ID do nível de ensino (Básico, curso extra e etc)
|-
|-
|pagina (paginação)
|pagina (paginação)
Linha 233:
Linha 236:
Informando o código, irá retornar a série correspondente cadastrada
Informando o código, irá retornar a série correspondente cadastrada
+|
+|-
+|
+|nivelEnsino
+|ID do nível de ensino (Básico, curso extra e etc)
|
|
|-
|-
Linha 404:
Linha 412:
Informando o código, irá retornar a série correspondente cadastrada
Informando o código, irá retornar a série correspondente cadastrada
+|-
+|
+|nivelEnsino
+|ID do nível de ensino (Básico, curso extra e etc)
|-
|-
|
|
Linha 530:
Linha 542:
|statusMatricula
|statusMatricula
|Status da matrícula que deve ser considerada na busca. Opções: MAT(Matrículado), ATI(Ativo), PRE (Pré matrícula)
|Status da matrícula que deve ser considerada na busca. Opções: MAT(Matrículado), ATI(Ativo), PRE (Pré matrícula)
+|-
+|
+|nivelEnsino
+|ID do nível de ensino (Básico, curso extra e etc)
|-
|-
|
|
Linha 735:
Linha 751:
|bit
|bit
|1
|1
+|-
+|placaCarro
+|Placa do carro, quando tiver mais de uma, separadas por ;
+|Texto
+|50
|}
|}
Linha 818:
Linha 839:
|PessoaAutorizada
|PessoaAutorizada
|0..N
|0..N
+|-
+|horarioEntrada
+|Horário entrada no padrão HH:mm:ss
+|Texto
+|10
+|-
+|horarioSaida
+|Horário saídano padrão HH:mm:ss
+|Texto
+|10
|}
|}
====Estado:====
====Estado:====
Linha 1 681:
Linha 1 712:
|Mínimo
|Mínimo
|Máximo
|Máximo
+|Obrigatório
|-
|-
|'''nome'''
|'''nome'''
Linha 1 687:
Linha 1 719:
|1
|1
|70
|70
+|Sim
|-
|-
|'''celular'''
|'''celular'''
Linha 1 693:
Linha 1 726:
|11
|11
|15
|15
+|Não
|-
|-
|'''cpf'''
|'''cpf'''
Linha 1 699:
Linha 1 733:
|11
|11
|11
|11
+|Sim
|-
|-
|'''email'''
|'''email'''
Linha 1 705:
Linha 1 740:
|>1
|>1
|255
|255
+|Não
|-
|-
|'''enderecoBairro'''
|'''enderecoBairro'''
Linha 1 711:
Linha 1 747:
|1
|1
|60
|60
+|Não
|-
|-
|'''enderecoCep'''
|'''enderecoCep'''
Linha 1 717:
Linha 1 754:
|8
|8
|8
|8
+|Sim
|-
|-
|'''enderecoCidade'''
|'''enderecoCidade'''
Linha 1 723:
Linha 1 761:
|1
|1
|20
|20
+|Sim
|-
|-
|'''enderecoComplemento'''
|'''enderecoComplemento'''
Linha 1 729:
Linha 1 768:
|0
|0
|60
|60
+|Não
|-
|-
|'''enderecoEstado'''
|'''enderecoEstado'''
Linha 1 735:
Linha 1 775:
|2
|2
|2
|2
+|Sim
|-
|-
|'''enderecoLogradouro'''
|'''enderecoLogradouro'''
Linha 1 741:
Linha 1 782:
|1
|1
|60
|60
+|Sim
|-
|-
|'''enderecoNumero'''
|'''enderecoNumero'''
Linha 1 747:
Linha 1 789:
|0
|0
|7
|7
+|Não
|-
|-
|'''nascimento'''
|'''nascimento'''
Linha 1 753:
Linha 1 796:
|10
|10
|10
|10
+|Não*
+<nowiki>*</nowiki>Se não tiver filiação 1 ou 2 informadas, o aluno precisa ser maior de 18 anos
|-
|-
|'''rg'''
|'''rg'''
Linha 1 759:
Linha 1 804:
|>1
|>1
|25
|25
+|Não
|-
|-
|'''sexo'''
|'''sexo'''
Linha 1 767:
Linha 1 813:
|8
|8
|15
|15
+|Não
|-
|-
|'''nacionalidade'''
|'''nacionalidade'''
Linha 1 773:
Linha 1 820:
|0
|0
|30
|30
+|Não
|-
|-
|'''filiacao1'''
|'''filiacao1'''
Linha 1 779:
Linha 1 827:
|
|
|
|
+|Sim
|-
|-
|'''filiacao2'''
|'''filiacao2'''
Linha 1 785:
Linha 1 834:
|
|
|
|
+|Sim
|-
|-
|'''rm'''
|'''rm'''
Linha 1 791:
Linha 1 841:
|0*
|0*
|20
|20
+|Não*
+<nowiki>*</nowiki>Sim caso esteja desligada a autonumeração
+|-
+|'''horarioEntrada'''
+|Horário entrada no padrão HH:mm:ss
+|S
+|0
+|10
+|Horário de entrada definido para o aluno
+|-
+|'''horarioSaida'''
+|Horário saída no padrão HH:mm:ss
+|
+|
+|
+|Horário de saída definido para o aluno
|}
|}
Linha 1 802:
Linha 1 868:
|Mínimo
|Mínimo
|Máximo
|Máximo
+|Obrigatório
|-
|-
|'''nome'''
|'''nome'''
−|Nome do aluno.
+|Nome do resposável.
|S
|S
|1
|1
|70
|70
+|Sim
|-
|-
|'''celular'''
|'''celular'''
Linha 1 814:
Linha 1 882:
|11
|11
|15
|15
+|Não
|-
|-
|'''cpf'''
|'''cpf'''
Linha 1 820:
Linha 1 889:
|11
|11
|11
|11
+|Não
|-
|-
|'''email'''
|'''email'''
−|Email do aluno Ex: aluno@aluno.com.br
+|Email do responsável Ex: resp@aluno.com.br
|S
|S
|>1
|>1
|255
|255
+|Sim
|-
|-
|'''enderecoBairro'''
|'''enderecoBairro'''
Linha 1 832:
Linha 1 903:
|1
|1
|60
|60
+|Sim
|-
|-
|'''enderecoCep'''
|'''enderecoCep'''
Linha 1 838:
Linha 1 910:
|8
|8
|8
|8
+|Sim
|-
|-
|'''enderecoCidade'''
|'''enderecoCidade'''
−|Cidade do end residencial do aluno Ex. jundiai
+|Cidade do end residencial do responsavel Ex. jundiai
|S
|S
|1
|1
|20
|20
+|Sim
|-
|-
|'''enderecoComplemento'''
|'''enderecoComplemento'''
Linha 1 850:
Linha 1 924:
|0
|0
|60
|60
+|Não
|-
|-
|'''enderecoEstado'''
|'''enderecoEstado'''
Linha 1 856:
Linha 1 931:
|2
|2
|2
|2
+|Sim
|-
|-
|'''enderecoLogradouro'''
|'''enderecoLogradouro'''
Linha 1 862:
Linha 1 938:
|1
|1
|60
|60
+|Sim
|-
|-
|'''enderecoNumero'''
|'''enderecoNumero'''
Linha 1 868:
Linha 1 945:
|0
|0
|7
|7
+|Não
|-
|-
|'''nascimento'''
|'''nascimento'''
Linha 1 874:
Linha 1 952:
|10
|10
|10
|10
+|Sim
|-
|-
|'''rg'''
|'''rg'''
Linha 1 880:
Linha 1 959:
|>1
|>1
|25
|25
+|Sim
|-
|-
|'''sexo'''
|'''sexo'''
Linha 1 888:
Linha 1 968:
|8
|8
|15
|15
+|Sim
|-
|-
|'''nacionalidade'''
|'''nacionalidade'''
−|Nacionalidade do aluno
+|Nacionalidade do responsável
|S
|S
|0
|0
|30
|30
+|Não
+|-
+|'''placasCarro'''
+|Array de String com os números das placas no padrão antigo ou novo
+|S
+|0
+|10
+|Não
|}
|}
Linha 1 985:
Linha 2 074:
|Mínimo
|Mínimo
|Máximo
|Máximo
+|Obrigatório
|-
|-
|'''cpf_cnpj'''
|'''cpf_cnpj'''
Linha 1 991:
Linha 2 081:
|11
|11
|11
|11
+|Sim
|-
|-
|'''codigoIntegracao'''
|'''codigoIntegracao'''
Linha 1 997:
Linha 2 088:
|1
|1
|255
|255
+|Sim
|-
|-
|'''codigoMatriculaUnico'''
|'''codigoMatriculaUnico'''
Linha 2 003:
Linha 2 095:
|1
|1
|255
|255
+|Sim
|-
|-
|'''codigoUnidade'''
|'''codigoUnidade'''
Linha 2 009:
Linha 2 102:
|1
|1
|3
|3
+|SIm*
|-
|-
|'''numeroSerieDeMatricula'''
|'''numeroSerieDeMatricula'''
Linha 2 015:
Linha 2 109:
|1
|1
|3
|3
+|Sim*
|-
|-
|'''valor'''
|'''valor'''
Linha 2 021:
Linha 2 116:
|
|
|
|
+|Não
|-
|-
|'''quantidadeParcelas'''
|'''quantidadeParcelas'''
Linha 2 027:
Linha 2 123:
|1
|1
|3
|3
+|Não
|-
|-
|'''formaPagamento'''
|'''formaPagamento'''
Linha 2 040:
Linha 2 137:
|3
|3
|20
|20
+|Não
|-
|-
|'''origem'''
|'''origem'''
Linha 2 046:
Linha 2 144:
|1
|1
|50
|50
+|Não
|-
|-
|'''titulos'''
|'''titulos'''
Linha 2 054:
Linha 2 153:
|
|
|
|
+|Não
|-
|-
|'''notificarAlunoAcessoPortal'''
|'''notificarAlunoAcessoPortal'''
Linha 2 060:
Linha 2 160:
|4
|4
|6
|6
+|Não
|-
|-
|'''periodoLetivo'''
|'''periodoLetivo'''
Linha 2 066:
Linha 2 167:
|0
|0
|20
|20
+|Não
|}
|}
+<nowiki>*</nowiki>Na inclusão
====Respostas esperadas====
====Respostas esperadas====
Linha 2 080:
Linha 2 183:
Status 500: Status Processamento: ERRO
Status 500: Status Processamento: ERRO
+
+======Principais validações conhecidas referentes ao erro HTTP 417: Regras de negócio======
+Manutenção de matrícula
+
+ - Ter um código sku (identificador único)
+
+ Atualização
+
+ - Não pode o código Identificador único da matrícula estar associado a Outro CPF
+
+ Erro: Já existe um aluno com CPF diferente ({0}) usando o mesmo código de mátricula único {1}
+
+ - 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}.
+
+ - 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====
====Exemplo====
Linha 2 517:
Linha 2 697:
"dataVencimento": "30/07/2021",
"dataVencimento": "30/07/2021",
+
+"codigoIntegracao": "SKU_TESTE",
+
+ "codigoMatriculaUnico": "UYJA_HAHHS",
"nomeSacado": "Luíza da Silva",
"nomeSacado": "Luíza da Silva",
Linha 2 529:
Linha 2 713:
"tituloSituacaoRemote": "PENDENTE",
"tituloSituacaoRemote": "PENDENTE",
+
+"codigoIntegracao": "SKU_TESTE",
+
+ "codigoMatriculaUnico": "UYJA_HAHHS",
"dataVencimento": "30/08/2021",
"dataVencimento": "30/08/2021",
Linha 2 702:
Linha 2 890:
]
]
+
+==WebHooks==
+[[Gestão Escolar - API de integração - Webhook|Clique aqui para acessar o manual]]
----
----
----
----
[[Category:GestaoEscolar]]
[[Category:GestaoEscolar]]
[[Category:API]]
[[Category:API]]
