Anônimo

Mudanças

De UltramaxWiki

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

Edição das 19h52min de 6 de janeiro de 2023

5 075 bytes adicionados ,  19h52min de 6 de janeiro de 2023
Inclusão dos WS de enturmamento para aluno e professor
Linha 972: Linha 972:  
|
 
|
 
|}
 
|}
 +
 +
=== Enturmamento aluno ===
 +
Realiza a busca dos alunos e as turmas que frequentam com disciplina no modelo especifico do google for education. Para que seja retornado deve seguir os seguintes pré requisitos:
 +
 +
* Matrícula deve ter o status matriculado ou ativa
 +
* A turma deve ter status diferente de encerrado
 +
* O cursa do aluno deve ter o status cursando
 +
* A série deve estar ativa
 +
 +
Método: GET
 +
 +
(base)/gestaoescolar/services/enturmamento/rest/aluno
 +
 +
==== Query string (parâmetro) ====
 +
{| class="wikitable"
 +
|+
 +
!Obrigatório
 +
!Campo
 +
!Descrição
 +
|-
 +
|Sim
 +
|portal
 +
|Portal externo que deseja buscar o enturmamento dos alunos, o e-mail do aluno no retorno será o de login a esse portal, os valores aceitos são:
 +
-GOOGLE_FOR_EDUCATION;
 +
 +
-MICROSOFT_TEAMS;
 +
|}
 +
 +
==== Respostas esperadas ====
 +
Status 200: : OK
 +
 +
Status 417: : Caso não seja informado o portal ou o mesmo não seja cadastrado na escola
 +
 +
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado
 +
{| class="wikitable"
 +
|+
 +
!Atributo
 +
!Descrição
 +
!Tipo
 +
!Tamanho
 +
|-
 +
|CURSO_CODIGO
 +
|Código do curso
 +
|Texto
 +
|15
 +
|-
 +
|CURSO_ID
 +
|Identificador do curso
 +
|Número
 +
|
 +
|-
 +
|CURSO_NOME
 +
|Nome do curso
 +
|Texto
 +
|70
 +
|-
 +
|DISCIPLINA_CODIGO
 +
|Identificador da disciplina
 +
|Número
 +
|
 +
|-
 +
|DISCIPLINA_NOME
 +
|Nome da disciplina
 +
|Texto
 +
|200
 +
|-
 +
|IE_CODIGO
 +
|Código da instituição de ensino fornecido pelo portal externo
 +
|Texto
 +
|
 +
|-
 +
|IE_ID
 +
|Identificado da instituição de ensino fornecido pelo portal externo
 +
|Texto
 +
|
 +
|-
 +
|IE_NOME
 +
|Nome da instituição de ensino fornecido pelo portal externo
 +
|Texto
 +
|
 +
|-
 +
|PERIODO_CODIGO
 +
|Identificador do período letivo
 +
|Número
 +
|
 +
|-
 +
|PERIODO_LETIVO
 +
|Nome do período letivo
 +
|Número
 +
|
 +
|-
 +
|SERIE_CODIGO
 +
|Código para a série concatenando código do curso e seqência da série no curso
 +
|Texto
 +
|
 +
|-
 +
|SERIE_ID
 +
|Identificador da série
 +
|Número
 +
|
 +
|-
 +
|SERIE_NOME
 +
|Nome da série
 +
|Texto
 +
|70
 +
|-
 +
|TURMA_CODIGO
 +
|Replica o nome da turma
 +
|Texto
 +
|65
 +
|-
 +
|TURMA_DISCIPLINA_CODIGO
 +
|Código que associa a turma com a disciplina no quadro curricular
 +
|Número
 +
|
 +
|-
 +
|TURMA_ID
 +
|Identificador da turma
 +
|Número
 +
|
 +
|-
 +
|TURMA_NOME
 +
|Nome da turma
 +
|Texto
 +
|65
 +
|-
 +
|ALUNO_RA
 +
|RM do aluno
 +
|Texto
 +
|20
 +
|-
 +
|ALUNO_ID
 +
|Identificador do aluno
 +
|Número
 +
|
 +
|-
 +
|ALUNO_NOME
 +
|Nome do aluno
 +
|Texto
 +
|70
 +
|-
 +
|ALUNO_EMAIL
 +
|E-mail do aluno para acesso ao portal
 +
|Texto
 +
|255
 +
|-
 +
|ALUNO_CPF
 +
|CPF do aluno
 +
|Número
 +
|
 +
|-
 +
|RESP_PED_NOME
 +
|Nome do responsável pedagógico
 +
|Texto
 +
|70
 +
|-
 +
|RESP_PED_EMAIL
 +
|E-mail pessoal do responsável pedagógico
 +
|Texto
 +
|255
 +
|}
 +
 +
=== Enturmamento professor ===
 +
Realiza a busca dos professores e as turmas que lecionam com disciplina no modelo especifico do google for education. Para que seja retornado deve seguir os seguintes pré requisitos:
 +
 +
* O período letivo deve estar ativo
 +
* Turma tem que ter status diferente de encerrado
 +
* A série deve estar ativa
 +
 +
Método: GET
 +
 +
(base)/gestaoescolar/services/enturmamentoProfessor/rest/professor
 +
 +
==== Query string (parâmetro) ====
 +
{| class="wikitable"
 +
|+
 +
!Obrigatório
 +
!Campo
 +
!Descrição
 +
|-
 +
|Sim
 +
|portal
 +
|Portal externo que deseja buscar o enturmamento dos alunos, o e-mail do aluno no retorno será o de login a esse portal, os valores aceitos são:
 +
-GOOGLE_FOR_EDUCATION;
 +
 +
-MICROSOFT_TEAMS;
 +
|}
 +
 +
==== Respostas esperadas ====
 +
Status 200: : OK
 +
 +
Status 417: : Caso não seja informado o portal ou o mesmo não seja cadastrado na escola
 +
 +
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado
 +
{| class="wikitable"
 +
|+
 +
!Atributo
 +
!Descrição
 +
!Tipo
 +
!Tamanho
 +
|-
 +
|CURSO_CODIGO
 +
|Código do curso
 +
|Texto
 +
|15
 +
|-
 +
|CURSO_ID
 +
|Identificador do curso
 +
|Número
 +
|
 +
|-
 +
|CURSO_NOME
 +
|Nome do curso
 +
|Texto
 +
|70
 +
|-
 +
|DISCIPLINA_CODIGO
 +
|Identificador da disciplina
 +
|Número
 +
|
 +
|-
 +
|DISCIPLINA_NOME
 +
|Nome da disciplina
 +
|Texto
 +
|200
 +
|-
 +
|IE_CODIGO
 +
|Código da instituição de ensino fornecido pelo portal externo
 +
|Texto
 +
|
 +
|-
 +
|IE_ID
 +
|Identificado da instituição de ensino fornecido pelo portal externo
 +
|Texto
 +
|
 +
|-
 +
|IE_NOME
 +
|Nome da instituição de ensino fornecido pelo portal externo
 +
|Texto
 +
|
 +
|-
 +
|PERIODO_CODIGO
 +
|Identificador do período letivo
 +
|Número
 +
|
 +
|-
 +
|PERIODO_LETIVO
 +
|Nome do período letivo
 +
|Número
 +
|
 +
|-
 +
|SERIE_CODIGO
 +
|Código para a série concatenando código do curso e seqência da série no curso
 +
|Texto
 +
|
 +
|-
 +
|SERIE_ID
 +
|Identificador da série
 +
|Número
 +
|
 +
|-
 +
|SERIE_NOME
 +
|Nome da série
 +
|Texto
 +
|70
 +
|-
 +
|TURMA_CODIGO
 +
|Replica o nome da turma
 +
|Texto
 +
|65
 +
|-
 +
|TURMA_DISCIPLINA_CODIGO
 +
|Código que associa a turma com a disciplina no quadro curricular
 +
|Número
 +
|
 +
|-
 +
|TURMA_ID
 +
|Identificador da turma
 +
|Número
 +
|
 +
|-
 +
|TURMA_NOME
 +
|Nome da turma
 +
|Texto
 +
|65
 +
|-
 +
|PROFESSOR_CODIGO
 +
|Replica o identificador do professor
 +
|Número
 +
|
 +
|-
 +
|PROFESSOR_CPF
 +
|CPF do professor
 +
|Número
 +
|
 +
|-
 +
|PROFESSOR_EMAIL
 +
|E-mail do professor para acesso ao portal externo
 +
|Texto
 +
|255
 +
|-
 +
|PROFESSOR_ID
 +
|Identificador do professor
 +
|Número
 +
|
 +
|-
 +
|PROFESSOR_NOME
 +
|Nome do professor
 +
|Texto
 +
|70
 +
|-
 +
|PROFESSOR_PERFIL
 +
|Retorna fixo o valor 4
 +
|
 +
|
 +
|-
 +
|TURMA_DISCIPLINA_PERFIL
 +
|Retorna fixo o valor 4
 +
|
 +
|
 +
|-
 +
|TURMA_TIPO_ID
 +
|Retorna fixo o valor 4
 +
|
 +
|
 +
|}
 +
 
==APIS para manutenção da base de dados==
 
==APIS para manutenção da base de dados==
  
Gilvanildo
privado
4

edições

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