privado
4
edições
Mudanças
Ir para navegação
Ir para pesquisar
Linha 973:
Linha 973: − + − + − + − + − + Linha 985:
Linha 985: − + Linha 1 000:
Linha 1 000: − + Linha 1 134:
Linha 1 134: − + − + − + − + Linha 1 145:
Linha 1 145: − + Linha 1 154:
Linha 1 154: − + Linha 1 160:
Linha 1 160: − + Linha 1 285:
Linha 1 285: − + − + + − | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Gestão Escolar - API de integração (ver código-fonte)
Edição das 10h28min de 9 de janeiro de 2023
, 10h28min de 9 de janeiro de 2023Inclusão do WS de cadastro de chave de acesso a portal externo
|}
|}
=== Enturmamento aluno ===
===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:
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
*Matrícula deve ter o status matriculado ou ativa
* A turma deve ter status diferente de encerrado
*A turma deve ter status diferente de encerrado
* O cursa do aluno deve ter o status cursando
*O cursa do aluno deve ter o status cursando
* A série deve estar ativa
*A série deve estar ativa
Método: GET
Método: GET
(base)/gestaoescolar/services/enturmamento/rest/aluno
(base)/gestaoescolar/services/enturmamento/rest/aluno
==== Query string (parâmetro) ====
====Query string (parâmetro)====
{| class="wikitable"
{| class="wikitable"
|+
|+
|}
|}
==== Respostas esperadas ====
====Respostas esperadas====
Status 200: : OK
Status 200: : OK
|}
|}
=== Enturmamento professor ===
===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:
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
*O período letivo deve estar ativo
* Turma tem que ter status diferente de encerrado
*Turma tem que ter status diferente de encerrado
* A série deve estar ativa
*A série deve estar ativa
Método: GET
Método: GET
(base)/gestaoescolar/services/enturmamentoProfessor/rest/professor
(base)/gestaoescolar/services/enturmamentoProfessor/rest/professor
==== Query string (parâmetro) ====
====Query string (parâmetro)====
{| class="wikitable"
{| class="wikitable"
|+
|+
|Sim
|Sim
|portal
|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:
|Portal externo que deseja buscar o enturmamento dos professor, o e-mail do aluno no retorno será o de login a esse portal, os valores aceitos são:
-GOOGLE_FOR_EDUCATION;
-GOOGLE_FOR_EDUCATION;
|}
|}
==== Respostas esperadas ====
====Respostas esperadas====
Status 200: : OK
Status 200: : OK
|PROFESSOR_PERFIL
|PROFESSOR_PERFIL
|Retorna fixo o valor 4
|Retorna fixo o valor 4
|
|Texto
|
|
|-
|-
|TURMA_DISCIPLINA_PERFIL
|TURMA_DISCIPLINA_PERFIL
|Retorna fixo o valor 4
|Retorna fixo o valor 4
|
|Texto
|
|
|-
|-
|TURMA_TIPO_ID
|TURMA_TIPO_ID
|Retorna fixo o valor 4
|Retorna fixo o valor 4
|Texto
|
|
|}
|}
=== Cadastrar chave do aluno ===
Realiza a atualização no perfil do aluno cadastrando a chave de acesso para aquele portal.
Método: POST
(base)/gestaoescolar/services/chavePortal/rest/aluno
==== Query string (parâmetro) ====
{| class="wikitable"
|+
!Obrigatório
!Campo
!Descrição
|-
|Sim
|portal
|Portal externo no qual deve ser cadastrada a chave de acesso do aluno, os valores aceitos são:
-GOOGLE_FOR_EDUCATION;
-MICROSOFT_TEAMS;
|-
|Sim
|atualizar
|Coleção de alunos que devem ser atualizados, cada elemento deve ter o identificador do aluno e o login daquele aluno no portal, serão respectivamente os campos id e chave
|}
'''Exemplo:'''
{
"portal":"GOOGLE_FOR_EDUCATION",
"atualizar":[
{
"chave": "alu3@email.com",
"id": 5
}
]
}
====Respostas esperadas====
Status 200: : OK
Status 417: : Caso não seja informado o portal ou o mesmo não seja cadastrado na escola ou caso de erro de validação no processo de gravação que será especificado no retorno.
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado
=== Cadastrar chave do professpr ===
Realiza a atualização no perfil do professor cadastrando a chave de acesso para aquele portal.
Método: POST
(base)/gestaoescolar/services/chavePortal/rest/professor
==== Query string (parâmetro) ====
{| class="wikitable"
|+
!Obrigatório
!Campo
!Descrição
|-
|Sim
|portal
|Portal externo no qual deve ser cadastrada a chave de acesso do aluno, os valores aceitos são:
-GOOGLE_FOR_EDUCATION;
-MICROSOFT_TEAMS;
|-
|Sim
|atualizar
|Coleção de professores que devem ser atualizados, cada elemento deve ter o identificador do professor e o login daquele professor no portal, serão respectivamente os campos id e chave
|}
'''Exemplo:'''
{
"portal":"GOOGLE_FOR_EDUCATION",
"atualizar":[
{
"chave": "alu3@email.com",
"id": 5
}
]
}
====Respostas esperadas====
Status 200: : OK
Status 417: : Caso não seja informado o portal ou o mesmo não seja cadastrado na escola ou caso de erro de validação no processo de gravação que será especificado no retorno.
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado
==APIS para manutenção da base de dados==
==APIS para manutenção da base de dados==