privado
180
edições
Mudanças
De UltramaxWiki
Gestão Escolar - API de integração (ver código-fonte)
Edição das 18h42min de 7 de abril de 2022
, 18h42min de 7 de abril de 2022→Query String (Parâmetros)
====Query String (Parâmetros)====
====Query String (Parâmetros)====
{| class="wikitable"
{| class="wikitable"
|Obrigatório
|Campo
|Campo
|Descrição
|Descrição
|-
|-
|SIm
|codigoUnidadeEnsino
|codigoUnidadeEnsino
|Código da unidade de ensino
|Código da unidade de ensino
|-
|-
|Sim
|periodoLetivo
|periodoLetivo
|Descrição do período letivo, deve ter o mesmo valor da descrição definida na Gestão Escolar. Por exemplo, se deve considerar apenas matrículas do período letivo de 2012, deve ser informado “2012”, exatamente como está cadastrado na gestão Escolar
|Descrição do período letivo, deve ter o mesmo valor da descrição definida na Gestão Escolar. Por exemplo, se deve considerar apenas matrículas do período letivo de 2012, deve ser informado “2012”, exatamente como está cadastrado na gestão Escolar
|-
|-
|
|codigo/sigla do curso
|codigo/sigla do curso
|Código do curso que deve ter as matrículas retornas
|Código do curso que deve ter as matrículas retornas
|-
|-
|
|numeroSequenciaSerie
|numeroSequenciaSerie
|Representa um número inteiro que define a ordem de sequência de uma série no curso. EX:
|Representa um número inteiro que define a ordem de sequência de uma série no curso. EX:
'''Importante:''' Esse parâmetro só será válido quando os parâmetros ''periodoLetivo'' e ''codigo/sigla do curso'' forem informados. Do contrário, será ignorado.
'''Importante:''' Esse parâmetro só será válido quando os parâmetros ''periodoLetivo'' e ''codigo/sigla do curso'' forem informados. Do contrário, será ignorado.
|-
|-
|
|nomeTurma
|nomeTurma
|Nome da turma exato que deve ser considerado
|Nome da turma exato que deve ser considerado
|-
|-
|
|nomeAluno
|nomeAluno
|Irá retornar todas as matrículas que contém a parte informada do nome
|Irá retornar todas as matrículas que contém a parte informada do nome
|-
|-
|
|Cpf
|Cpf
|Deve ter o valor numérico exato do CPF do aluno
|Deve ter o valor numérico exato do CPF do aluno
|-
|-
|
|RM
|RM
|Deve ter a String exata que representa a Registro de Matrícula do aluno
|Deve ter a String exata que representa a Registro de Matrícula do aluno
|-
|-
|
|statusMatricula
|statusMatricula
|Status da matrícula que deve ser considerada na busca
|Status da matrícula que deve ser considerada na busca
|-
|-
|
|Pagina (paginação)
|Pagina (paginação)
|Indica qual página está listando na sequência
|Indica qual página está listando na sequência
|-
|-
|
|Registros (paginação)
|Registros (paginação)
|Quantidade de registros que devem ser retornados em cada página
|Quantidade de registros que devem ser retornados em cada página
''*Os tipos de dados estão definidos abaixo''
''*Os tipos de dados estão definidos abaixo''
==== Responsavel: ====
====Responsavel:====
{| class="wikitable"
{| class="wikitable"
|'''Atributo'''
|'''Atributo'''
|}
|}
==== Aluno: ====
====Aluno:====
{| class="wikitable"
{| class="wikitable"
|'''Atributo'''
|'''Atributo'''
|}
|}
==== Estado: ====
====Estado:====
{| class="wikitable"
{| class="wikitable"
|'''Atributo'''
|'''Atributo'''
|}
|}
==== Endereco: ====
====Endereco:====
{| class="wikitable"
{| class="wikitable"
|'''Atributo'''
|'''Atributo'''
|}
|}
==== Turma: ====
====Turma:====
{| class="wikitable"
{| class="wikitable"
|'''Atributo'''
|'''Atributo'''
