privado
180
edições
Mudanças
Ir para navegação
Ir para pesquisar
Linha 46:
Linha 46: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Linha 206:
Linha 269: − − === CURSOS: 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/cursos?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 − |- − | − |nomeCurso − |Nome do curso para verificação se existe no cadastro de curso − |- − | − |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 − − Resposta: Conjunto de registros
Gestão Escolar - API de integração (ver código-fonte)
Edição das 15h19min de 7 de abril de 2022
, 15h19min de 7 de abril de 2022sem sumário de edição
Status 500. Caso algum erro interno ocorra durante o processamento
Status 500. Caso algum erro interno ocorra durante o processamento
== APIS para consultas ==
===CURSOS: 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/cursos?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
|-
|
|nomeCurso
|Nome do curso para verificação se existe no cadastro de curso
|-
|
|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
Resposta: Conjunto de registros
== APIS para manutenção da base de dados ==
===Manutenção de cursos===
===Manutenção de cursos===
}
}
{| class="wikitable"
{| class="wikitable"