Burocratas, privado, Administradores
1 691
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 812:
Linha 1 843:
|Não*
|Não*
<nowiki>*</nowiki>Sim caso esteja desligada a autonumeraçã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 930:
Linha 1 975:
|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
|Não
|}
|}
Linha 2 022:
Linha 2 074:
|Mínimo
|Mínimo
|Máximo
|Máximo
+|Obrigatório
|-
|-
|'''cpf_cnpj'''
|'''cpf_cnpj'''
Linha 2 028:
Linha 2 081:
|11
|11
|11
|11
+|Sim
|-
|-
|'''codigoIntegracao'''
|'''codigoIntegracao'''
Linha 2 034:
Linha 2 088:
|1
|1
|255
|255
+|Sim
|-
|-
|'''codigoMatriculaUnico'''
|'''codigoMatriculaUnico'''
Linha 2 040:
Linha 2 095:
|1
|1
|255
|255
+|Sim
|-
|-
|'''codigoUnidade'''
|'''codigoUnidade'''
Linha 2 046:
Linha 2 102:
|1
|1
|3
|3
+|SIm*
|-
|-
|'''numeroSerieDeMatricula'''
|'''numeroSerieDeMatricula'''
Linha 2 052:
Linha 2 109:
|1
|1
|3
|3
+|Sim*
|-
|-
|'''valor'''
|'''valor'''
Linha 2 058:
Linha 2 116:
|
|
|
|
+|Não
|-
|-
|'''quantidadeParcelas'''
|'''quantidadeParcelas'''
Linha 2 064:
Linha 2 123:
|1
|1
|3
|3
+|Não
|-
|-
|'''formaPagamento'''
|'''formaPagamento'''
Linha 2 077:
Linha 2 137:
|3
|3
|20
|20
+|Não
|-
|-
|'''origem'''
|'''origem'''
Linha 2 083:
Linha 2 144:
|1
|1
|50
|50
+|Não
|-
|-
|'''titulos'''
|'''titulos'''
Linha 2 091:
Linha 2 153:
|
|
|
|
+|Não
|-
|-
|'''notificarAlunoAcessoPortal'''
|'''notificarAlunoAcessoPortal'''
Linha 2 097:
Linha 2 160:
|4
|4
|6
|6
+|Não
|-
|-
|'''periodoLetivo'''
|'''periodoLetivo'''
Linha 2 103:
Linha 2 167:
|0
|0
|20
|20
+|Não
|}
|}
+<nowiki>*</nowiki>Na inclusão
====Respostas esperadas====
====Respostas esperadas====
Linha 2 824:
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]]
