Anônimo

Mudanças

De UltramaxWiki

Gestão Escolar - API de integração (ver código-fonte)

Edição das 15h37min de 7 de abril de 2022

5 531 bytes adicionados ,  15h37min de 7 de abril de 2022
→‎APIS para consultas
Linha 145: Linha 145:  
|Nome da turma (ficará vazio caso não tenha uma turma associada ainda no período
 
|Nome da turma (ficará vazio caso não tenha uma turma associada ainda no período
 
|Texto
 
|Texto
 +
|
 +
|}
 +
 +
===SÉRIES: 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/series?codigoUnidadeEnsino=1&periodoLetivo=2022
 +
 +
====Query String (Parâmetros)====
 +
{| class="wikitable"
 +
|Obrigatório
 +
|Campo
 +
|Descrição
 +
|-
 +
|Sim
 +
|Campo
 +
|Descrição
 +
|-
 +
|Sim
 +
|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
 +
|-
 +
|
 +
|sigla
 +
|Código  do curso que deve ter as matrículas retorna
 +
|-
 +
|
 +
|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
 +
 +
|-
 +
|
 +
|nomeSerie
 +
|Nome  da série será avaliado no campo da série se o valor contém o registro
 +
 +
|-
 +
|
 +
|Status
 +
|Indica  a situação da série que deve ser considerada (ATIVO, INATIVO)
 +
|-
 +
|
 +
|codigoIntegraCurso
 +
|Identificador  de integração entre o Sistema da ASAS e o da Ultramax no cadastro de cursos  de EAD. Vai servir também para identicar qualquer outro sistema de terceiro  que utilizar a API de integração de cursos para criar cursos no Gestão  Escolar
 +
 +
Informando  o código, irá retornar a série correspondente cadastrada
 +
|}
 +
 +
====Respostas esperadas====
 +
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
 +
|-
 +
|'''sigla'''
 +
|Código  identificador do Curso
 +
|Texto
 +
|
 +
|-
 +
|'''codigoUnidade'''
 +
|Código  da unidade de ensino que o curso pertence.
 +
|Texto
 +
|
 +
|-
 +
|'''periodoLeletivo'''
 +
|Descrição  do período Letivo atual
 +
|Texto
 +
|
 +
|-
 +
|'''codigoCurso'''
 +
|Código  do curso
 +
|Texto
 +
|
 +
|-
 +
|'''nomeCurso'''
 +
|Nome do  curso
 +
|Texto
 +
|
 +
|-
 +
|'''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
 +
|inteiro
 +
|
 +
|-
 +
|'''nomeSerie'''
 +
|Nome da  série
 +
|Inteiro
 +
|
 +
|-
 +
|'''Status'''
 +
|Situação  da série
 +
|Texto
 +
|
 +
|}
 +
 +
=== TURMAS: 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/turmas?codigoUnidadeEnsino=1&periodoLetivo=2022
 +
 +
====Query String (Parâmetros)====
 +
{| class="wikitable"
 +
|Obrigatório
 +
|Campo
 +
|Descrição
 +
|-
 +
|Sim
 +
|codigoUnidadeEnsino
 +
|Código  da unidade de ensino
 +
|-
 +
|Sim
 +
|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
 +
|-
 +
|
 +
|Nome  do turma
 +
|Texto  para localizar parcialmente os registros usando a descrição da turma
 +
|-
 +
|
 +
|codigo/sigla  do curso
 +
|Código  do curso que deve ter as matrículas retorna
 +
|-
 +
|
 +
|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.
 +
|-
 +
|
 +
|nomeCurso
 +
|Nome  do curso para verificação se existe no cadastro de curso
 +
 +
'''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.
 +
|-
 +
|
 +
|Status
 +
|Situação  possíveis para busca da turma (VIGENTE, EM_FORMACAO,ENCERRADA)
 +
|-
 +
|
 +
|codigoIntegracaoCurso
 +
|Identificador  de integração entre o Sistema da ASAS e o da Ultramax no cadastro de cursos  de EAD. Vai servir também para identicar qualquer outro sistema de terceiro  que utilizar a API de integração de cursos para criar cursos no Gestão  Escolar
 +
 +
Informando  o código, irá retornar a série correspondente cadastrada
 +
|}
 +
 +
====Respostas esperadas====
 +
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
 +
|-
 +
|'''codigoUnidade'''
 +
|Código  da unidade de ensino que o curso pertence.
 +
|Texto
 +
|
 +
|-
 +
|'''periodoLeletivo'''
 +
|Descrição  do período Letivo atual
 +
|Texto
 +
|
 +
|-
 +
|'''sigla'''
 +
|Código  do curso
 +
|Texto
 +
|
 +
|-
 +
|'''nomeCurso'''
 +
|Nome do  curso
 +
|Texto
 +
|
 +
|-
 +
|'''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
 +
|Texto
 +
|
 +
|-
 +
|'''nomeSerie'''
 +
|Nome da  série
 +
|inteiro
 +
|
 +
|-
 +
|'''nomeTurma'''
 +
|Nome da  turma
 +
|Inteiro
 
|
 
|
 
|}
 
|}
Wescley
privado
180

edições

Disponível em “http://wiki.ultramax.com.br/mediawiki/index.php/Especial:MobileDiff/10680”