Mudanças

Ir para navegação Ir para pesquisar
sem sumário de edição
Linha 352: Linha 352:  
|Nome da  turma
 
|Nome da  turma
 
|Inteiro
 
|Inteiro
 +
|
 +
|}
 +
 +
=== MATRÍCULAS: Obtendo dados: ===
 +
Busca os cursos cadastrados na base de dados de acordo com os parâmetros informados na query string.
 +
 +
Método: GET
 +
 +
(base)/gestaoescolar/services/v1/matriculas?codigoUnidadeEnsino=1&periodoLetivo=2022
 +
 +
====Query String (Parâmetros)====
 +
{| class="wikitable"
 +
|Campo
 +
|Descrição
 +
|-
 +
|codigoUnidadeEnsino
 +
|Código  da unidade de ensino
 +
|-
 +
|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
 +
|-
 +
|codigo/sigla  do curso
 +
|Código  do curso que deve ter as matrículas retornas
 +
|-
 +
|numeroSequenciaSerie
 +
|Representa  um número inteiro que define a ordem de sequência de uma série no curso. EX:
 +
 +
Ao definir o curso Robótica com três séries (1º, 2º, 3º), no cadastro de  séries da Gestão Escolar é definida a ordem de sequência de cada série para o  curso, para que seja possível saber para qual série o Aluno vai ao fim  de cada período letivo.
 +
 +
Informando  o número exato, será retornada as matrículas especificas daquela série
 +
 +
'''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
 +
|Nome  da turma exato que deve ser considerado
 +
|-
 +
|nomeAluno
 +
|Irá  retornar todas as matrículas que contém a parte informada do nome
 +
|-
 +
|Cpf
 +
|Deve  ter o valor numérico exato do CPF do aluno
 +
|-
 +
|RM
 +
|Deve  ter a String exata que representa a Registro de Matrícula do aluno
 +
|-
 +
|statusMatricula
 +
|Status  da matrícula que deve ser considerada na busca
 +
|-
 +
|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
 +
|}
 +
Status 200: : OK
 +
 +
Status 412: : Caso não seja informado o código da unidade de negócio e a descrição do período letivo
 +
{| class="wikitable"
 +
|'''Atributo'''
 +
|'''Descrição'''
 +
|Tipo
 +
|Tamanho
 +
|-
 +
|'''cpf_cnpj'''
 +
|CPF do  aluno que será gerada a matrícula, apenas numeros
 +
|Número
 +
|
 +
|-
 +
|'''codigoIntegracao'''
 +
|Código  de integração para um Curso existente
 +
|Número
 +
|
 +
|-
 +
|'''codigoMatriculaUnico'''
 +
|Código  de integração para busca de uma matrícula ou para criar uma nova
 +
|Texto
 +
|255
 +
|-
 +
|'''codigoUnidade'''
 +
|Código  da unidade de ensino que o curso pertence.
 +
|
 +
|
 +
|-
 +
|'''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úmero
 +
|
 +
|-
 +
|'''valor'''
 +
|Valor  total do curso. Ex. 1000.0 definido para a série
 +
|Número
 +
|
 +
|-
 +
|'''quantidadeParcelas'''
 +
|Quantidade  de parcelas de parcelas padrão configurado para a série
 +
|Número
 +
|
 +
|-
 +
|'''origem'''
 +
|Origem  da matrícula, como padrão "Plataforma EAD"
 +
|Texto
 +
|20
 +
|-
 +
|'''títulos'''
 +
|Títulos  gerados para a matrícula
 +
|Titulo*
 +
|1..N
 +
|-
 +
|'''Aluno'''
 +
|Dados  básicos do aluno que devem ser considerados no retorno da matricula
 +
|Aluno*
 +
|1..1
 +
|-
 +
|'''StatusMatricula'''
 +
|Status  atual da matrícula
 +
|Texto
 +
|30
 +
|-
 +
|'''periodoLetivo'''
 +
|Descrição  do período letivo
 +
|Texto
 +
|20
 +
|-
 +
|'''sigla'''
 +
|Código  do curso referente a matrícula
 +
|Texto
 +
|15
 +
|-
 +
|'''Turmas'''
 +
|Arrays  de turmas que a matrícula pertence
 +
|Turma*
 +
|1..N
 +
|}
 +
Título:
 +
{| class="wikitable"
 +
|'''Atributo'''
 +
|'''Descrição'''
 +
|Tipo
 +
|Tamanho
 +
|-
 +
|
 +
|
 +
|
 
|
 
|
 
|}
 
|}
privado
180

edições

Menu de navegação