privado
180
edições
Mudanças
De UltramaxWiki
Gestão Escolar - API de integração (ver código-fonte)
Edição das 20h41min de 7 de abril de 2022
, 20h41min de 7 de abril de 2022sem sumário de edição
====Query String (Parâmetros)====
====Query String (Parâmetros)====
{| class="wikitable"
{| class="wikitable"
|Campo
|Campo
|Descrição
|Descrição
|-
|-
|codigoUnidadeEnsino
|codigoUnidadeEnsino
|Código da unidade de ensino
|Código da unidade de ensino
|-
|-
|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
|-
|-
|Nome do turma
|Nome do turma
|Texto para localizar parcialmente os registros usando a descrição da turma
|Texto para localizar parcialmente os registros usando a descrição da turma
|-
|-
|sigla
|sigla
|Código do curso que deve ter as matrículas retorna
|Código do curso que deve ter as matrículas retorna
|-
|-
|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:
Informando o número exato, será retornada as matrículas especificas daquela série
Informando o número exato, será retornada as matrículas especificas daquela série
|-
|-
|nomeCurso
|nomeCurso
|Nome do curso para verificação se existe no cadastro de curso
|Nome do curso para verificação se existe no cadastro de curso
|-
|-
|Status
|Status
|Situação possíveis para busca da turma (VIGENTE, EM_FORMACAO,ENCERRADA)
|Situação possíveis para busca da turma (VIGENTE, EM_FORMACAO,ENCERRADA)
|-
|-
|codigoIntegracaoCurso
|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
|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
{| class="wikitable"
{| class="wikitable"
|Obrigatório
|Obrigatório
|Campo
|Campo
|Descrição
|Descrição
|Tamanho
|Tamanho
|-
|-
|'''sigla'''
|'''codigoIntegraCurso'''
|Código identificador do Curso
|Código identificador do Curso
|Texto
|Número
|
|
|-
|-
|'''codigoUnidade'''
|'''codigoUnidade'''
|Código da unidade de ensino que o curso pertence.
|Código da unidade de ensino que o curso pertence.
|Texto
|inteiro
|
|
|-
|-
|Descrição do período Letivo atual
|Descrição do período Letivo atual
|Texto
|Texto
|
|20
|-
|-
|'''codigoCurso'''
|'''codigoCurso'''
|Código do curso
|Código do curso
|Texto
|Texto
|
|15
|-
|-
|'''nomeCurso'''
|'''nomeCurso'''
|Nome do curso
|Nome do curso
|Texto
|Texto
|
|70
|-
|-
|'''numeroSerieDeMatricula'''
|'''numeroSerieDeMatricula'''
|'''nomeSerie'''
|'''nomeSerie'''
|Nome da série
|Nome da série
|Inteiro
|Texto
|
|70
|-
|-
|'''Status'''
|'''Status'''
|Situação da série
|Situação da série
|Texto
|Texto
|
|10
|}
|}
|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
|20
|20
|-
|-
|sigla
|codigoCurso
|Código do curso
|Código do curso
|Texto
|Texto
|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
|codigoUnidade
|codigoUnidade
|Código da unidade de ensino que o curso pertence.
|Código da unidade de ensino que o curso pertence.
|
|Número
|
|
|-
|-
|20
|20
|-
|-
|sigla
|Turmas
|Código do curso referente a matrícula
|Turmas que pertencem a matrícula
|Turma*
|0..N
|-
|codigoCurso
|Código do curso
|Texto
|Texto
|15
|15
|-
|-
|Turmas
|nomeCurso
|Arrays de turmas que a matrícula pertence
|Nome do curso
|Turma*
|Texto
|1..N
|70
|-
|nomeSerie
|Nome da série
|Texto
|70
|}
|}
''*Os tipos de dados estão definidos abaixo''
''*Os tipos de dados estão definidos abaixo''
