Mudanças

Ir para navegação Ir para pesquisar

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

Edição das 12h55min de 23 de fevereiro de 2024

7 480 bytes adicionados ,  23 fevereiro
→‎Resposta
Linha 813: Linha 813:  
|Texto
 
|Texto
 
|
 
|
 +
|-
 +
|pessoasAutorizadas
 +
|Pessoas que tem autorização para retirar o Aluno
 +
|PessoaAutorizada
 +
|0..N
 
|}
 
|}
 
====Estado:====
 
====Estado:====
Linha 872: Linha 877:  
|Estado da Federação que o aluno mora
 
|Estado da Federação que o aluno mora
 
|Estado*
 
|Estado*
 +
|
 +
|}
 +
 +
====PessoaAutorizada:====
 +
{| class="wikitable"
 +
|'''Atributo'''
 +
|'''Descrição'''
 +
|Tipo
 +
|Tamanho
 +
|-
 +
|nome
 +
|Nome da Pessoa
 +
|Texto
 +
|
 +
|-
 +
|rg
 +
|RG com número da pessoa autorizada
 +
|Texto
 +
|
 +
|-
 +
|parentesco
 +
|descrição com o parentesco da pessoa autorizada
 +
|Texto
 +
|
 +
|-
 +
|cpf
 +
|CPF da pessoa autorizada a retirar
 +
|Texto
 
|
 
|
 
|}
 
|}
Linha 978: Linha 1 011:  
|}
 
|}
   −
===Enturmamento aluno===
+
=====DadosTitulos:=====
−
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:
+
{| class="wikitable"
−
 
+
|'''Atributo'''
−
*Matrícula deve ter o status matriculado ou ativa
+
|'''Descrição'''
−
*A turma deve ter status diferente de encerrado
+
|Tipo
−
*O cursa do aluno deve ter o status cursando
+
|Tamanho
−
*A série deve estar ativa
+
|-
−
*O curso não deve estar com o campo "Não enviar na API de enturmamento" selecionado
+
|nome
−
 
+
|Nome da pessoa associada ao título (responsável pelo pagamento)
−
Método: GET
+
|Texto
−
 
+
|70
−
(base)/gestaoescolar/services/enturmamento/rest/aluno
+
|-
−
 
+
|dataDePagamento
−
====Query string (parâmetro)====
+
|Data que o pagamento do título foi efetivado
−
{| class="wikitable"
+
|Texto
−
|+
+
|10
−
!Obrigatório
  −
!Campo
  −
!Descrição
   
|-
 
|-
−
|Sim
+
|dataFaturamento
−
|portal
+
|A data que a nota fiscal associada ao boleto/título foi gerada, ou, caso ainda não tenha sido gerada, a Data prevista para faturamento (data associada ao título no Gestão Escolar)
−
|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:
+
|Texto
−
-GOOGLE_FOR_EDUCATION;
+
|10
−
 
  −
-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
+
|vencimento
−
|Código do curso
+
|Data de vencimento prevista para o título
 
|Texto
 
|Texto
−
|15
+
|10
 
|-
 
|-
−
|CURSO_ID
+
|inicioCurso
−
|Identificador do curso
+
|Data com início que a matrícula do aluno está configurado
−
|Número
+
|Texto
−
|
+
|10
 
|-
 
|-
−
|CURSO_NOME
+
|curso
−
|Nome do curso
+
|Nome do curso que está associada a matrícula
 
|Texto
 
|Texto
 
|70
 
|70
 
|-
 
|-
−
|DISCIPLINA_CODIGO
+
|rm
−
|Identificador da disciplina
+
|RA do aluno com identificador único
−
|Número
+
|Texto
−
|
+
|20
 
|-
 
|-
−
|DISCIPLINA_NOME
+
|status
−
|Nome da disciplina
+
|Situação atual da matrícula
 
|Texto
 
|Texto
−
|200
+
|30
 
|-
 
|-
−
|IE_CODIGO
+
|turma
−
|Código da instituição de ensino fornecido pelo portal externo
+
|Turma principal associada a matricula
 
|Texto
 
|Texto
−
|
+
|65
 
|-
 
|-
−
|IE_ID
+
|valorCobrado
−
|Identificado da instituição de ensino fornecido pelo portal externo
+
|Valor efetivamente cobrado para o título  (baixado)
−
|Texto
+
|Numero
 
|
 
|
 
|-
 
|-
−
|IE_NOME
+
|valorDocumento
−
|Nome da instituição de ensino fornecido pelo portal externo
+
|Valor base esperado para o título (não considera descontos configurados)
−
|Texto
  −
|
  −
|-
  −
|PERIODO_CODIGO
  −
|Identificador do período letivo
  −
|Número
  −
|
  −
|-
  −
|PERIODO_LETIVO
  −
|Nome do período letivo
   
|Número
 
|Número
 
|
 
|
 +
|}
 +
 +
===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
 +
*O curso não deve estar com o campo "Não enviar na API de enturmamento" selecionado
 +
 +
Método: GET
 +
 +
(base)/gestaoescolar/services/enturmamento/rest/aluno
 +
 +
====Query string (parâmetro)====
 +
{| class="wikitable"
 +
|+
 +
!Obrigatório
 +
!Campo
 +
!Descrição
 
|-
 
|-
−
|SERIE_CODIGO
+
|Sim
−
|Código para a série concatenando código do curso e seqência da série no curso
+
|portal
−
|Texto
+
|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;
−
|-
+
 
−
|SERIE_ID
+
-MICROSOFT_TEAMS;
−
|Identificador da série
+
|}
 +
 
 +
====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
 
|Número
 
|
 
|
 
|-
 
|-
−
|SERIE_NOME
+
|CURSO_NOME
−
|Nome da série
+
|Nome do curso
 
|Texto
 
|Texto
 
|70
 
|70
 
|-
 
|-
−
|TURMA_CODIGO
+
|DISCIPLINA_CODIGO
−
|Replica o nome da turma
+
|Identificador da disciplina
−
|Texto
  −
|65
  −
|-
  −
|TURMA_DISCIPLINA_CODIGO
  −
|Código que associa a turma com a disciplina no quadro curricular
   
|Número
 
|Número
 
|
 
|
 
|-
 
|-
−
|TURMA_ID
+
|DISCIPLINA_NOME
−
|Identificador da turma
+
|Nome da disciplina
−
|Número
+
|Texto
−
|
+
|200
 
|-
 
|-
−
|TURMA_NOME
+
|IE_CODIGO
−
|Nome da turma
+
|Código da instituição de ensino fornecido pelo portal externo
 
|Texto
 
|Texto
−
|65
+
|
 
|-
 
|-
−
|ALUNO_RA
+
|IE_ID
−
|RM do aluno
+
|Identificado da instituição de ensino fornecido pelo portal externo
 
|Texto
 
|Texto
−
|20
+
|
 
|-
 
|-
−
|ALUNO_ID
+
|IE_NOME
−
|Identificador do aluno
+
|Nome da instituição de ensino fornecido pelo portal externo
 +
|Texto
 +
|
 +
|-
 +
|PERIODO_CODIGO
 +
|Identificador do período letivo
 
|Número
 
|Número
 
|
 
|
 
|-
 
|-
−
|ALUNO_NOME
+
|PERIODO_LETIVO
−
|Nome do aluno
+
|Nome do período letivo
−
|Texto
+
|Número
−
|70
+
|
 
|-
 
|-
−
|ALUNO_EMAIL
+
|SERIE_CODIGO
−
|E-mail do aluno para acesso ao portal
+
|Código para a série concatenando código do curso e seqência da série no curso
 
|Texto
 
|Texto
−
|255
+
|
 
|-
 
|-
−
|ALUNO_CPF
+
|SERIE_ID
−
|CPF do aluno
+
|Identificador da série
 
|Número
 
|Número
 
|
 
|
 
|-
 
|-
−
|RESP_PED_NOME
+
|SERIE_NOME
−
|Nome do responsável pedagógico
+
|Nome da série
 
|Texto
 
|Texto
 
|70
 
|70
 
|-
 
|-
−
|RESP_PED_EMAIL
+
|TURMA_CODIGO
−
|E-mail pessoal do responsável pedagógico
+
|Replica o nome da turma
 
|Texto
 
|Texto
−
|255
+
|65
−
|}
  −
 
  −
===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
  −
*O curso não deve estar com o campo "Não enviar na API de enturmamento" selecionado
  −
 
  −
Método: GET
  −
 
  −
(base)/gestaoescolar/services/enturmamentoProfessor/rest/professor
  −
 
  −
====Query string (parâmetro)====
  −
{| class="wikitable"
  −
|+
  −
!Obrigatório
  −
!Campo
  −
!Descrição
   
|-
 
|-
−
|Sim
+
|TURMA_DISCIPLINA_CODIGO
−
|portal
+
|Código que associa a turma com a disciplina no quadro curricular
−
|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;
  −
 
  −
-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
 
|Número
 
|
 
|
 
|-
 
|-
−
|CURSO_NOME
+
|TURMA_ID
−
|Nome do curso
+
|Identificador da turma
−
|Texto
  −
|70
  −
|-
  −
|DISCIPLINA_CODIGO
  −
|Identificador da disciplina
   
|Número
 
|Número
 
|
 
|
 
|-
 
|-
−
|DISCIPLINA_NOME
+
|TURMA_NOME
−
|Nome da disciplina
+
|Nome da turma
 
|Texto
 
|Texto
−
|200
+
|65
 
|-
 
|-
−
|IE_CODIGO
+
|ALUNO_RA
−
|Código da instituição de ensino fornecido pelo portal externo
+
|RM do aluno
 
|Texto
 
|Texto
 +
|20
 +
|-
 +
|ALUNO_ID
 +
|Identificador do aluno
 +
|Número
 
|
 
|
 
|-
 
|-
−
|IE_ID
+
|ALUNO_NOME
−
|Identificado da instituição de ensino fornecido pelo portal externo
+
|Nome do aluno
 
|Texto
 
|Texto
−
|
+
|70
 
|-
 
|-
−
|IE_NOME
+
|ALUNO_EMAIL
−
|Nome da instituição de ensino fornecido pelo portal externo
+
|E-mail do aluno para acesso ao portal
 
|Texto
 
|Texto
−
|
+
|255
 
|-
 
|-
−
|PERIODO_CODIGO
+
|ALUNO_CPF
−
|Identificador do período letivo
+
|CPF do aluno
 
|Número
 
|Número
 
|
 
|
 
|-
 
|-
−
|PERIODO_LETIVO
+
|RESP_PED_NOME
−
|Nome do período letivo
+
|Nome do responsável pedagógico
−
|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
 
|Texto
 
|70
 
|70
 
|-
 
|-
−
|TURMA_CODIGO
+
|RESP_PED_EMAIL
−
|Replica o nome da turma
+
|E-mail pessoal do responsável pedagógico
 
|Texto
 
|Texto
−
|65
+
|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
 +
*O curso não deve estar com o campo "Não enviar na API de enturmamento" selecionado
 +
 
 +
Método: GET
 +
 
 +
(base)/gestaoescolar/services/enturmamentoProfessor/rest/professor
 +
 
 +
====Query string (parâmetro)====
 +
{| class="wikitable"
 +
|+
 +
!Obrigatório
 +
!Campo
 +
!Descrição
 
|-
 
|-
−
|TURMA_DISCIPLINA_CODIGO
+
|Sim
−
|Código que associa a turma com a disciplina no quadro curricular
+
|portal
 +
|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;
 +
 
 +
-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
 
|Número
 
|
 
|
 
|-
 
|-
−
|TURMA_ID
+
|CURSO_NOME
−
|Identificador da turma
+
|Nome do curso
 +
|Texto
 +
|70
 +
|-
 +
|DISCIPLINA_CODIGO
 +
|Identificador da disciplina
 
|Número
 
|Número
 
|
 
|
 
|-
 
|-
−
|TURMA_NOME
+
|DISCIPLINA_NOME
−
|Nome da turma
+
|Nome da disciplina
 
|Texto
 
|Texto
−
|65
+
|200
 
|-
 
|-
−
|PROFESSOR_CODIGO
+
|IE_CODIGO
−
|Replica o identificador do professor
+
|Código da instituição de ensino fornecido pelo portal externo
−
|Número
+
|Texto
 
|
 
|
 
|-
 
|-
−
|PROFESSOR_CPF
+
|IE_ID
−
|CPF do professor
+
|Identificado da instituição de ensino fornecido pelo portal externo
−
|Número
+
|Texto
 
|
 
|
 
|-
 
|-
−
|PROFESSOR_EMAIL
+
|IE_NOME
−
|E-mail do professor para acesso ao portal externo
+
|Nome da instituição de ensino fornecido pelo portal externo
 
|Texto
 
|Texto
−
|255
+
|
 
|-
 
|-
−
|PROFESSOR_ID
+
|PERIODO_CODIGO
−
|Identificador do professor
+
|Identificador do período letivo
 
|Número
 
|Número
 
|
 
|
 
|-
 
|-
−
|PROFESSOR_NOME
+
|PERIODO_LETIVO
−
|Nome do professor
+
|Nome do período letivo
−
|Texto
+
|Número
−
|70
+
|
 
|-
 
|-
−
|PROFESSOR_PERFIL
+
|SERIE_CODIGO
−
|Retorna fixo o valor 4
+
|Código para a série concatenando código do curso e seqência da série no curso
 
|Texto
 
|Texto
 
|
 
|
 
|-
 
|-
−
|TURMA_DISCIPLINA_PERFIL
+
|SERIE_ID
−
|Retorna fixo o valor 4
+
|Identificador da série
−
|Texto
+
|Número
 
|
 
|
 
|-
 
|-
−
|TURMA_TIPO_ID
+
|SERIE_NOME
−
|Retorna fixo o valor 4
+
|Nome da série
 
|Texto
 
|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
 
|
 
|
−
|}
  −
  −
===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
+
|TURMA_ID
−
|portal
+
|Identificador da turma
−
|Portal externo no qual deve ser cadastrada a chave de acesso do aluno, os valores aceitos são:
+
|Número
−
-GOOGLE_FOR_EDUCATION;
+
|
−
 
+
|-
−
-MICROSOFT_TEAMS;
+
|TURMA_NOME
 +
|Nome da turma
 +
|Texto
 +
|65
 +
|-
 +
|PROFESSOR_CODIGO
 +
|Replica o identificador do professor
 +
|Número
 +
|
 
|-
 
|-
−
|Sim
+
|PROFESSOR_CPF
−
|atualizar
+
|CPF do professor
−
|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
+
|Número
−
|}
+
|
−
'''Exemplo:'''
+
|-
−
 
+
|PROFESSOR_EMAIL
−
{
+
|E-mail do professor para acesso ao portal externo
−
 
+
|Texto
−
   "portal":"GOOGLE_FOR_EDUCATION",
+
|255
−
 
+
|-
−
   "atualizar":[
+
|PROFESSOR_ID
−
 
+
|Identificador do professor
−
       {
+
|Número
−
 
+
|
−
           "chave": "alu3@email.com",
+
|-
−
 
+
|PROFESSOR_NOME
−
           "id": 5
+
|Nome do professor
−
 
+
|Texto
−
       }
+
|70
−
 
+
|-
−
   ]
+
|PROFESSOR_PERFIL
−
 
+
|Retorna fixo o valor 4
−
}
+
|Texto
−
 
+
|
−
====Respostas esperadas====
+
|-
−
Status 200: : OK
+
|TURMA_DISCIPLINA_PERFIL
 +
|Retorna fixo o valor 4
 +
|Texto
 +
|
 +
|-
 +
|TURMA_TIPO_ID
 +
|Retorna fixo o valor 4
 +
|Texto
 +
|
 +
|}
   −
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.
+
===Cadastrar chave do aluno===
−
 
+
Realiza a atualização no perfil do aluno cadastrando a chave de acesso para aquele portal.
−
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
 
Método: POST
   −
(base)/gestaoescolar/services/chavePortal/rest/professor
+
(base)/gestaoescolar/services/chavePortal/rest/aluno
    
====Query string (parâmetro)====
 
====Query string (parâmetro)====
Linha 1 381: Linha 1 425:  
|Sim
 
|Sim
 
|atualizar
 
|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
+
|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:'''
 
'''Exemplo:'''
Linha 1 409: Linha 1 453:     
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado
 
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==
     −
===Manutenção de cursos===
+
===Cadastrar chave do professpr===
−
Faz a manutenção de um curso. Através do código de integração será localizado um curso existente para alteração ou, caso não exista, será criado um novo curso
+
Realiza a atualização no perfil do professor cadastrando a chave de acesso para aquele portal.
   −
Método: Post
+
Método: POST
   −
(base)/gestaoescolar/services/curso/rest/add
+
(base)/gestaoescolar/services/chavePortal/rest/professor
   −
====Body====
+
====Query string (parâmetro)====
 
{| class="wikitable"
 
{| class="wikitable"
−
|'''Atributo'''
+
|+
−
|'''Descrição'''
+
!Obrigatório
−
|Tipo
+
!Campo
−
|Mínimo
+
!Descrição
−
|Máximo
   
|-
 
|-
−
|'''sigla'''
+
|Sim
−
|Código  identificador do Curso
+
|portal
−
|S
+
|Portal externo no qual deve ser cadastrada a chave de acesso do aluno, os valores aceitos são:
−
|1
+
-GOOGLE_FOR_EDUCATION;
−
|15
+
 
 +
-MICROSOFT_TEAMS;
 
|-
 
|-
−
|'''codigoUnidade'''
+
|Sim
−
|Código da unidade de ensino que o curso pertence. Fixo "1"
+
|atualizar
−
|N
+
|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
−
|1
+
|}
−
|3
+
'''Exemplo:'''
−
|-
+
 
−
|'''nome'''
+
{
−
|Descrição do curso
+
 
−
|S
+
   "portal":"GOOGLE_FOR_EDUCATION",
−
|1
+
 
−
|70
+
   "atualizar":[
−
|-
+
 
−
|'''itemServico'''
+
       {
−
|Código  do serviço para emissão de NFS-e. Depende de cada instituição e do curso. Por  exemplo: 05673. Ver com a instituição qual código usar para cada curso
  −
|S
  −
|4
  −
|9
  −
|-
  −
|'''codigoIntegracao'''
  −
|Código único de integração,  será a chave entre os diferentes sistemas
  −
|S
  −
|1
  −
|255
  −
|-
  −
|'''modalidadeCurso'''
  −
|‘EAD’  fixo
  −
|S
  −
|1
  −
|30
  −
|-
  −
|'''naturezaOperacao'''
  −
|Natureza de operação será usada na geração das notas fiscais
  −
Valores válidos:
     −
CANCELADO("Cancelado"),
+
           "chave": "alu3@email.com",
   −
EXIGIBILIDADE_SUSPENSAO_DECISAO_JUDICAL(
+
           "id": 5
   −
       "Exigibilidade por suspensão de decisão judicial - Válido até 22/02/2015"),
+
       }
   −
EXIGIBILIDADE_SUSPENSAO_DECISAO_JUDICAL_2(
+
   ]
   −
       "Exigibilidade por suspensão de decisão judicial"),
+
}
   −
EXIGIBILIDADE_SUSPENSAO_PROCEDIMENTO_ADM(
+
====Respostas esperadas====
 +
Status 200: : OK
   −
       "Exigibilidade por suspensão de procedimento administrativo - Válido até 22/02/2015"),
+
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.
   −
EXIGIBILIDADE_SUSPENSAO_PROCEDIMENTO_ADM_2(
+
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==
   −
       "Exigibilidade por suspensão de procedimento administrativo"),
+
===Manutenção de cursos===
 +
Faz a manutenção de um curso. Através do código de integração será localizado um curso existente para alteração ou, caso não exista, será criado um novo curso
   −
EXIGIBILIDADE_SUSPENSAO_TRIBUTADO_FORA_MUNICIPIO(
+
Método: Post
   −
       "Tributado fora do Munícipio, porém Exigibilidade Suspensa - Válido a partir de 23/02/2015"),
+
(base)/gestaoescolar/services/curso/rest/add
   −
EXIGIBILIDADE_SUSPENSAO_TRIBUTADO_MUNICIPIO(
+
====Body====
−
 
+
{| class="wikitable"
−
       "Tributado no Munícipio, porém Exigibilidade Suspensa - Válido a partir de 23/02/2015"),
+
|'''Atributo'''
−
 
+
|'''Descrição'''
−
EXPORTACAO( "Exportação"),
+
|Tipo
−
 
+
|Mínimo
−
EXPORTACAO_SERVICO(
+
|Máximo
−
 
+
|-
−
       "Exportação de serviços - Válido a partir de 23/02/2015"),
+
|'''sigla'''
−
 
+
|Código  identificador do Curso
−
EXTRAVIADO("Extraviado - Válido até 22/02/2015"),
+
|S
−
 
+
|1
−
IMUNE("Imune - Válido até 22/02/2015"),
+
|15
−
 
+
|-
−
IMUNIDADE("Imunidade"),
+
|'''codigoUnidade'''
−
 
+
|Código da unidade de ensino que o curso pertence. Fixo "1"
−
ISENCAO("Isenção - Válido até 22/02/2015"),
+
|N
−
 
+
|1
−
ISENCAO_ATUAL("Isenção"),
+
|3
−
 
+
|-
−
MICRO_EMPREENDEDOR_INDIVIDUAL("Micro Empreendedor Individual (MEI)"),
+
|'''nome'''
 +
|Descrição do curso
 +
|S
 +
|1
 +
|70
 +
|-
 +
|'''itemServico'''
 +
|Código  do serviço para emissão de NFS-e. Depende de cada instituição e do curso. Por  exemplo: 05673. Ver com a instituição qual código usar para cada curso
 +
|S
 +
|4
 +
|9
 +
|-
 +
|'''codigoIntegracao'''
 +
|Código único de integração, será a chave entre os diferentes sistemas
 +
|S
 +
|1
 +
|255
 +
|-
 +
|'''modalidadeCurso'''
 +
|‘EAD’  fixo
 +
|S
 +
|1
 +
|30
 +
|-
 +
|'''naturezaOperacao'''
 +
|Natureza de operação será usada na geração das notas fiscais
 +
Valores válidos:
   −
SIMPLES("Simples Nacional"),
+
CANCELADO("Cancelado"),
   −
TRIBUTACAO_FORA_MUNICIPIO("Tributação fora do munipio"),
+
EXIGIBILIDADE_SUSPENSAO_DECISAO_JUDICAL(
   −
TRIBUTACAO_MUNICIPIO("Tributação no municipio"),
+
       "Exigibilidade por suspensão de decisão judicial - Válido até 22/02/2015"),
   −
TRIBUTADO_FORA_MUNICIPIO_IMUNE()
+
EXIGIBILIDADE_SUSPENSAO_DECISAO_JUDICAL_2(
   −
       "Tributado fora do município, porém Imune - Válido a partir de 23/02/2015"),
+
       "Exigibilidade por suspensão de decisão judicial"),
   −
TRIBUTADO_FORA_MUNICIPIO_ISENTO(
+
EXIGIBILIDADE_SUSPENSAO_PROCEDIMENTO_ADM(
   −
       "Tributado fora do município, porém Isento - Válido a partir de 23/02/2015"),
+
       "Exigibilidade por suspensão de procedimento administrativo - Válido até 22/02/2015"),
   −
TRIBUTADO_MUNICIPIO_IMUNE("Tributado no município, porém Imune - Válido a partir de 23/02/2015"),
+
EXIGIBILIDADE_SUSPENSAO_PROCEDIMENTO_ADM_2(
   −
TRIBUTADO_MUNICIPIO_ISENTO("Tributado no município, porém Isento - Válido a partir de 23/02/2015");
+
       "Exigibilidade por suspensão de procedimento administrativo"),
−
|N
  −
|1
  −
|50
  −
|}
     −
====Respostas esperadas====
+
EXIGIBILIDADE_SUSPENSAO_TRIBUTADO_FORA_MUNICIPIO(
−
Status 200: Status Processamento: OK
     −
Status 417: Status Processamento: JACADASTRADO. Quando a mesma sigla de curso está cadastrado em mais de um registro.
+
       "Tributado fora do Munícipio, porém Exigibilidade Suspensa - Válido a partir de 23/02/2015"),
   −
Status  500:  Status Processamento: ERRO
+
EXIGIBILIDADE_SUSPENSAO_TRIBUTADO_MUNICIPIO(
   −
====Exemplo:====
+
       "Tributado no Munícipio, porém Exigibilidade Suspensa - Válido a partir de 23/02/2015"),
   −
=====Requisição=====
+
EXPORTACAO( "Exportação"),
−
{"sigla":"Curso","codigoUnidade":1,"nome":"Curso teste","itemServico":"545454","codigoIntegracao":"SA-KJ-AD-NB","modalidadeCurso":"EAD"}
     −
=====Resposta=====
+
EXPORTACAO_SERVICO(
−
{
     −
   "dados": {
+
       "Exportação de serviços - Válido a partir de 23/02/2015"),
   −
       "sigla": "Curso",
+
EXTRAVIADO("Extraviado - Válido até 22/02/2015"),
   −
"codigoUnidade":1,
+
IMUNE("Imune - Válido até 22/02/2015"),
   −
       "nome": "Curso teste",
+
IMUNIDADE("Imunidade"),
   −
       "itemServico": "545454",
+
ISENCAO("Isenção - Válido até 22/02/2015"),
   −
       "codigoIntegracao": "SA-KJ-AD-NB",
+
ISENCAO_ATUAL("Isenção"),
   −
       "modalidadeCurso": "EAD"
+
MICRO_EMPREENDEDOR_INDIVIDUAL("Micro Empreendedor Individual (MEI)"),
   −
   },
+
SIMPLES("Simples Nacional"),
   −
   "statusProcessamento": "OK",
+
TRIBUTACAO_FORA_MUNICIPIO("Tributação fora do munipio"),
   −
   "response": "ACCEPTED",
+
TRIBUTACAO_MUNICIPIO("Tributação no municipio"),
   −
   "acao": "Manutenção OK"
+
TRIBUTADO_FORA_MUNICIPIO_IMUNE()
   −
}
+
       "Tributado fora do município, porém Imune - Válido a partir de 23/02/2015"),
   −
===Manutenção de alunos===
+
TRIBUTADO_FORA_MUNICIPIO_ISENTO(
−
Adiciona ou altera um aluno. Através do C.P.F informado será localizado na base de dados do gestão escolar o aluno correspondente. Caso encontre, será atualizado todos os campos bases enviados no header, por outro lado, caso não encontre, será incluído um novo registro para o aluno.
     −
Método: Post
+
       "Tributado fora do município, porém Isento - Válido a partir de 23/02/2015"),
   −
(base)/gestaoescolar/services/aluno/rest/responsavelfinanceiro
+
TRIBUTADO_MUNICIPIO_IMUNE("Tributado no município, porém Imune - Válido a partir de 23/02/2015"),
   −
====Body====
+
TRIBUTADO_MUNICIPIO_ISENTO("Tributado no município, porém Isento - Válido a partir de 23/02/2015");
−
{| class="wikitable"
+
|N
−
|'''Atributo'''
  −
|'''Descrição'''
  −
|Tipo
  −
|Mínimo
  −
|Máximo
  −
|-
  −
|'''nome'''
  −
|Nome do aluno.
  −
|S
   
|1
 
|1
−
|70
+
|50
−
|-
+
|}
−
|'''celular'''
+
 
−
|Número de telefone celular Ex: 11998465521 ou (11) 99999-9999
+
====Respostas esperadas====
−
|S
+
Status 200: Status Processamento: OK
−
|11
+
 
−
|15
+
Status 417: Status Processamento: JACADASTRADO. Quando a mesma sigla de curso está cadastrado em mais de um registro.
−
|-
+
 
−
|'''cpf'''
+
Status  500:  Status Processamento: ERRO
−
|Sequencia numérica com o CPF do aluno Ex. 65696655565
+
 
−
|N
+
====Exemplo:====
−
|11
+
 
−
|11
+
=====Requisição=====
−
|-
+
{"sigla":"Curso","codigoUnidade":1,"nome":"Curso teste","itemServico":"545454","codigoIntegracao":"SA-KJ-AD-NB","modalidadeCurso":"EAD"}
−
|'''email'''
+
 
−
|Email  do aluno Ex: aluno@aluno.com.br
+
=====Resposta=====
−
|S
+
{
−
|>1
+
 
−
|255
+
   "dados": {
−
|-
+
 
−
|'''enderecoBairro'''
+
       "sigla": "Curso",
−
|Bairro do end residencial do aluno Ex. vila didi
+
 
−
|S
+
"codigoUnidade":1,
−
|1
+
 
−
|60
+
       "nome": "Curso teste",
−
|-
+
 
−
|'''enderecoCep'''
+
       "itemServico": "545454",
−
|CEP  do end residencial do aluno Ex. 13203320
+
 
−
|S
+
       "codigoIntegracao": "SA-KJ-AD-NB",
−
|8
+
 
−
|8
+
       "modalidadeCurso": "EAD"
−
|-
+
 
−
|'''enderecoCidade'''
+
   },
−
|Cidade do end residencial do aluno Ex. jundiai
+
 
 +
   "statusProcessamento": "OK",
 +
 
 +
   "response": "ACCEPTED",
 +
 
 +
   "acao": "Manutenção OK"
 +
 
 +
}
 +
 
 +
===Manutenção de alunos===
 +
Adiciona ou altera um aluno. Através do C.P.F informado será localizado na base de dados do gestão escolar o aluno correspondente. Caso encontre, será atualizado todos os campos bases enviados no header, por outro lado, caso não encontre, será incluído um novo registro para o aluno.
 +
 
 +
Método: Post
 +
 
 +
(base)/gestaoescolar/services/aluno/rest/responsavelfinanceiro
 +
 
 +
====Body====
 +
{| class="wikitable"
 +
|'''Atributo'''
 +
|'''Descrição'''
 +
|Tipo
 +
|Mínimo
 +
|Máximo
 +
|-
 +
|'''nome'''
 +
|Nome do aluno.
 
|S
 
|S
 
|1
 
|1
−
|20
+
|70
 
|-
 
|-
−
|'''enderecoComplemento'''
+
|'''celular'''
−
|Complemento  do end residencial do aluno Ex. casa
+
|Número de telefone celular Ex: 11998465521 ou (11) 99999-9999
 
|S
 
|S
−
|0
+
|11
−
|60
+
|15
 +
|-
 +
|'''cpf'''
 +
|Sequencia numérica com o CPF do aluno Ex. 65696655565
 +
|N
 +
|11
 +
|11
 
|-
 
|-
−
|'''enderecoEstado'''
+
|'''email'''
−
|Estado do end residencial do aluno Ex. SP Max 2 caracteres  deve ser a sigla correspondente ao Estado
+
|Email  do aluno Ex: aluno@aluno.com.br
 
|S
 
|S
−
|2
+
|>1
−
|2
+
|255
 
|-
 
|-
−
|'''enderecoLogradouro'''
+
|'''enderecoBairro'''
−
|Logradouro  do end residencial do aluno Ex. rua guapore
+
|Bairro do end residencial do aluno Ex. vila didi
 
|S
 
|S
 
|1
 
|1
 
|60
 
|60
 
|-
 
|-
−
|'''enderecoNumero'''
+
|'''enderecoCep'''
−
|Número do end residencial do aluno Ex. 521
+
|CEP  do end residencial do aluno Ex. 13203320
 
|S
 
|S
−
|0
+
|8
−
|7
+
|8
 
|-
 
|-
−
|'''nascimento'''
+
|'''enderecoCidade'''
−
|Date com a data de nascimento do aluno dd/MM/yyyy
+
|Cidade do end residencial do aluno Ex. jundiai
 
|S
 
|S
−
|10
+
|1
−
|10
+
|20
 
|-
 
|-
−
|'''rg'''
+
|'''enderecoComplemento'''
−
|RG do aluno Ex: 584245999
+
|Complemento do end residencial do aluno Ex. casa
 
|S
 
|S
−
|>1
+
|0
−
|25
+
|60
 
|-
 
|-
−
|'''sexo'''
+
|'''enderecoEstado'''
−
|Indicador do gênero do aluno Ex MASCULINO.
+
|Estado do end residencial do aluno Ex. SP Max 2 caracteres  deve ser a sigla correspondente ao Estado
−
 
  −
MASCULINO/FEMININO/NAODECLARADO
   
|S
 
|S
−
|8
+
|2
−
|15
+
|2
 +
|-
 +
|'''enderecoLogradouro'''
 +
|Logradouro  do end residencial do aluno Ex. rua guapore
 +
|S
 +
|1
 +
|60
 
|-
 
|-
−
|'''nacionalidade'''
+
|'''enderecoNumero'''
−
|Nacionalidade do aluno
+
|Número do end residencial do aluno Ex. 521
 
|S
 
|S
 
|0
 
|0
−
|30
+
|7
 
|-
 
|-
−
|'''filiacao1'''
+
|'''nascimento'''
−
|Filiação 1 do aluno (Detalhes tabela pessoa)
+
|Date com a data de nascimento do aluno dd/MM/yyyy
−
|PessoaRemote
+
|S
−
|
+
|10
−
|
+
|10
 
|-
 
|-
−
|'''filiacao2'''
+
|'''rg'''
−
|Filiação 2 do aluno (Detalhes tabela pessoa)
+
|RG  do aluno Ex: 584245999
−
|PessoaRemote
+
|S
 +
|>1
 +
|25
 +
|-
 +
|'''sexo'''
 +
|Indicador do gênero do aluno Ex MASCULINO.
 +
 
 +
MASCULINO/FEMININO/NAODECLARADO
 +
|S
 +
|8
 +
|15
 +
|-
 +
|'''nacionalidade'''
 +
|Nacionalidade do aluno
 +
|S
 +
|0
 +
|30
 +
|-
 +
|'''filiacao1'''
 +
|Filiação 1 do aluno (Detalhes tabela pessoa)
 +
|PessoaRemote
 +
|
 +
|
 +
|-
 +
|'''filiacao2'''
 +
|Filiação 2 do aluno (Detalhes tabela pessoa)
 +
|PessoaRemote
 
|
 
|
 
|
 
|
Linha 1 985: Linha 2 081:  
Status  500:  Status Processamento: ERRO
 
Status  500:  Status Processamento: ERRO
   −
====Exemplo====
+
======Principais validações conhecidas referentes ao erro HTTP 417: Regras de negócio======
 +
Manutenção de matrícula
   −
=====Requisição=====
+
   - Ter um código sku (identificador único)      
−
{"cpf_cnpj":2865474325,"codigoIntegracao":"SA-KJ-AD-NB","codigoMatriculaUnico":"201254", "codigoUnidade":"1","numeroSerieDeMatricula":1,"valor":1000.0,"quantidadeParcelas":1,"formaPagamento":"DINHEIRO"}
     −
=====Resposta=====
+
   Atualização
−
{
+
 
 +
       - Não pode o código Identificador único da matrícula estar associado a Outro CPF
 +
 
 +
           Erro: Já existe um aluno com CPF diferente ({0}) usando o mesmo código de mátricula único {1}
 +
 
 +
       - O código integração do curso "codigoIntegracao" deve estar associado a algum curso no GE
 +
 
 +
           Erro: Código SKU do curso não foi informado
 +
 
 +
       - O código integração do curso "codigoIntegracao" deve ser igual ao código de integração de cursa da matrícula já existente
 +
 
 +
           Erro: O código de integração do curso ({0}) não é o mesmo código SKU já definido para a matrícula: {1}
   −
   "dados": {
+
       - Caso a matrícula existente não seja uma pré matrícula e não tenha nenhuma disciplina já associada (cursa)
   −
       "pagamentoCartao": false,
+
           Erro: A matrícula {0} não tem nenhuma disciplina associada                      
   −
       "cpf_cnpj": 2865474325,
+
   Inclusão
   −
       "codigoIntegracao": "SA-KJ-AD-NB",
+
       - codigoIntegracao fornecido não está associado a nenhum curso no GE
   −
       "codigoMatriculaUnico": "201254",
+
           Erro: Não foi localizado o curso correspondente para o código {0}           
   −
"codigoUnidade":1,
+
       - atributo cpf_cnpj fornecido não está associado a nenhum aluno no GE (Precisa cadastro o aluno antes)
   −
       "numeroSerieDeMatricula": 1,
+
           Erro: Não foi localizado o curso correspondente para o código {0}               
   −
       "valor": 1000.0,
+
       - atributo codigoUnidade fornecido não tem uma unidade de ensino com o mesmo código no GE
   −
       "quantidadeParcelas": 1,
+
           Erro: Não foi possível determinar qual será a unidade de ensino com o código {0} para a matrícula.           
   −
       "formaPagamento": "DINHEIRO",   },
+
       - atributo periodoLetivo fornecido não tem um período letivo correspondente no GE    
   −
   "statusProcessamento": "OK",
+
          Erro: ão foi possível determinar qual será a período letivo com o código {0} para a matrícula. Por favor entrar em contato com a secretaria e buscar no Wiki do sistema pelo código de ajuda: CFGAPI001           
   −
   "response": "ACCEPTED",
+
       - atributos numeroSerieDeMatricula e a combição dos atributo codigoIntegracao(curso), codigoUnidade (Unidade de ensino) e periodoLetivo (período letívo) devem localizar a série/turma que o aluno deve ser matrículado,  
   −
   "acao": "Manutenção OK"
+
          Erro: Não foi possível determinar qual será a série para a matrícula: Sequência: {0}.          
   −
}
+
        - atributo codigoIntegracao localizar um curso com modalidade EAD e valor do atributo valor for maior que zero e a série localizada não tiver mais de
   −
===Financeiro: Criação de título na matrícula (Titulo)===
+
uma receita obrigatória cadastrada    
   −
Usada na API de matrícula do aluno. Cada título deve ser adicionado na API da Matrícula do aluno. A API de matrículas foi alterada para permitir incluir títulos na alteração. Com isso, será possível adicionar novos títulos para matrículas já existentes, desde que o código "nosso número" já não esteja associado a outro títulos no sistema gestão escolar.
+
        Erro: A série deve conter apenas uma receita obrigatória. Por favor entrar em contato com a secretaria e buscar no Wiki do sistema pelo código de ajuda: CFGAPI001            
   −
{| class="wikitable"
+
       Geração dos boletos:       
−
|'''Atributo'''
+
 
−
|'''Descrição'''
+
       - Caso a matrícula tenha Tenha o atributo do valor maior que zero, e a modalidade do curso referente ao atributo codigoIntegracao for EAD
−
|Tipo
+
 
−
|Mínimo
+
e não tiver nenhum atributo "titulos" fornecido,  o processo vai tentar criar os títulos financeiros de acordo com o configurado na aba financeiro
−
|Máximo
+
 
−
|-
+
no gestão escolar e caso alguma despesa da matrícula existente não esteja configurada no financeiro da série dará o erro:
−
|'''dataVencimento'''
  −
|Data de vencimento do título
  −
|S
  −
|10
  −
|10
  −
|-
  −
|'''nossoNumero'''
  −
|Número gerado pelo sistema externo que criou o título e que deve ser compartilhado com o Gestão Escolar para que cada interação funcione de forma correta
  −
|S
  −
|1
  −
|50
  −
|-
  −
|'''valorDocumento'''
  −
|Valor que representa o título
  −
|N
  −
|
  −
|
  −
|}
     −
===Financeiro: Alteração de títulos===
+
           Erro:  A conta contábil de recebimento não está configurado na parte financeira da série para a receita:           
   −
Método: Post
+
       - Caso o atributo "titulos" esteja preenchido e a somatória do atributo do titulo chamado valorDocumento não bater com o atributo "valor" do
   −
(base)/gestaoescolar/services/financeiro/rest/titulo
+
corpo da matrícula.        
   −
Ao fazer um POST com indicando o  campo de integração (Nosso número) , o valor do documento e a data de vencimento o Web Service irá fazer alteração dos campos correspondentes no boleto já gerado durante a fase da matricula do aluno permitindo assim que os dados desses campos fiquem sincronizados entre os sistemas.
+
          Erro: O valor total informado ({0}) não bate com a somatória de valores de cada parcela ({1})          
   −
{| class="wikitable"
+
       -  Caso o curso associado seja da modalidade EAD e tenha o atributo valor maior que zero e a matrícula gerada durante a chamada fique sem nenhuma
−
|'''Atributo'''
  −
|'''Descrição'''
  −
|Tipo
  −
|Mínimo
  −
|Máximo
  −
|-
  −
|'''dataVencimento'''
  −
|Data de vencimento do título
  −
|S
  −
|10
  −
|10
  −
|-
  −
|'''nossoNumero'''
  −
|Número gerado pelo sistema externo que criou o título e que deve ser compartilhado com o Gestão Escolar para que cada interação funcione de forma correta
  −
|S
  −
|1
  −
|50
  −
|-
  −
|'''valorDocumento'''
  −
|Valor que representa o título
  −
|N
  −
|
  −
|
  −
|}
     −
'''Respostas esperadas'''
+
despesa de matrícula associada
   −
Status 200: Status Processamento: OK
+
           Erro: Não existe nenhuma despesa configurada para a matrícula, verifique se existe configuração de despesa financeira para a série {0} e então, inclua uma despesa para a matrícula.           
   −
Status 417: Status Processamento: TITULO_NAO_EXISTE (Quando o título informado não existe)
+
       - Caso o atributo "nossoNumero" do titulo já esteja associado a algum outro boleto no Gestão Escolar
   −
tatus 417: Status Processamento: ERRO: Erro genérico de negócio
+
           Erro: O título com o código externo {0} já existe, não é permitido adicionar a matrícula com a mesma referência
−
 
  −
Status  500:  Status Processamento: ERRO
      
====Exemplo====
 
====Exemplo====
    
=====Requisição=====
 
=====Requisição=====
−
Body:
+
{"cpf_cnpj":2865474325,"codigoIntegracao":"SA-KJ-AD-NB","codigoMatriculaUnico":"201254", "codigoUnidade":"1","numeroSerieDeMatricula":1,"valor":1000.0,"quantidadeParcelas":1,"formaPagamento":"DINHEIRO"}
−
 
  −
{"nossoNumero":"58745876","valorDocumento":"1100.0", "dataVencimento":"11/07/2021"}
      
=====Resposta=====
 
=====Resposta=====
 
{
 
{
−
  −
   "acao": "Manutenção OK",
      
   "dados": {
 
   "dados": {
   −
       "nomeSacado": "Aluno teste",
+
       "pagamentoCartao": false,
   −
       "numeroDocumento": 8597757,
+
       "cpf_cnpj": 2865474325,
   −
       "valorAbatimentoConcedido": 0.0,
+
       "codigoIntegracao": "SA-KJ-AD-NB",
   −
       "valorDescontoConcedido": 0.0,
+
       "codigoMatriculaUnico": "201254",
   −
       "valorDespesaCobranca": 0.0,
+
"codigoUnidade":1,
   −
       "valorDocumento": 1100.0,
+
       "numeroSerieDeMatricula": 1,
   −
       "valorLiquido": 0.0,
+
       "valor": 1000.0,
   −
       "valorMoraMulta": 0.0,
+
       "quantidadeParcelas": 1,
   −
       "valorOutrasDespesas": 0.0,
+
       "formaPagamento": "DINHEIRO",   },
   −
       "valorOutrosCreditos": 0.0,
+
   "statusProcessamento": "OK",
   −
       "dataVencimento": "10/07/2021",
+
   "response": "ACCEPTED",
   −
       "nossoNumero": "58745876"
+
   "acao": "Manutenção OK"
−
 
  −
   },
  −
 
  −
   "response": "OK",
  −
 
  −
   "statusProcessamento": "OK"
      
}
 
}
   −
===Financeiro: Baixa Título.===
+
===Financeiro: Criação de título na matrícula (Titulo)===
−
Método: Post
     −
(base)/gestaoescolar/services/financeiro/rest/titulo
+
Usada na API de matrícula do aluno. Cada título deve ser adicionado na API da Matrícula do aluno. A API de matrículas foi alterada para permitir incluir títulos na alteração. Com isso, será possível adicionar novos títulos para matrículas já existentes, desde que o código "nosso número" já não esteja associado a outro títulos no sistema gestão escolar.
    
{| class="wikitable"
 
{| class="wikitable"
Linha 2 152: Linha 2 204:  
|Mínimo
 
|Mínimo
 
|Máximo
 
|Máximo
 +
|-
 +
|'''dataVencimento'''
 +
|Data de vencimento do título
 +
|S
 +
|10
 +
|10
 
|-
 
|-
 
|'''nossoNumero'''
 
|'''nossoNumero'''
−
|Número gerado pelo sistema interno que criou o título e que deve ser compartilhado com o Gestão Escolar para que cada interação funcione de forma correta
+
|Número gerado pelo sistema externo que criou o título e que deve ser compartilhado com o Gestão Escolar para que cada interação funcione de forma correta
 
|S
 
|S
 
|1
 
|1
 
|50
 
|50
 
|-
 
|-
−
|'''formaPagamento'''
+
|'''valorDocumento'''
−
|Forma de pagamento para execução da baixa.
+
|Valor que representa o título
 +
|N
 +
|
 +
|
 +
|}
   −
Valores válidos:
+
===Financeiro: Alteração de títulos===
 +
 
 +
Método: Post
 +
 
 +
(base)/gestaoescolar/services/financeiro/rest/titulo
   −
DINHEIRO, CHEQUE, C_CREDITO,C_DEBITO, BOLETO, DEB_AUTOMATICO,TRANSFERENCIA,  DOC,OUTRO_BAIXA_ADM,DEPOSITO,DUPLICADA, FIES, PREFEITURA,PROUNI, FOLHA_DE_PGTO, CHEQUE_PRE,PAGAMENTO_ONLINE, PERMUTA, PIX
+
Ao fazer um POST com indicando o campo de integração (Nosso número) , o valor do documento e a data de vencimento o Web Service irá fazer alteração dos campos correspondentes no boleto já gerado durante a fase da matricula do aluno permitindo assim que os dados desses campos fiquem sincronizados entre os sistemas.
   −
|S
+
{| class="wikitable"
−
|3
+
|'''Atributo'''
−
|20
+
|'''Descrição'''
 +
|Tipo
 +
|Mínimo
 +
|Máximo
 
|-
 
|-
−
|'''dataOcorrencia'''
+
|'''dataVencimento'''
−
|Data de aconteceu a baixa do título, essa data será usada como referência pela baixa no gestão escolar e deve ser incluída,
+
|Data de vencimento do título
 
|S
 
|S
 
|10
 
|10
 
|10
 
|10
 
|-
 
|-
−
|'''valorPagamento'''
+
|'''nossoNumero'''
−
|Valor do pagamento que deve ser executado no gestão escolar
+
|Número gerado pelo sistema externo que criou o título e que deve ser compartilhado com o Gestão Escolar para que cada interação funcione de forma correta
−
|N
+
|S
−
|
+
|1
−
|
+
|50
−
|-
  −
|'''dataVencimento'''
  −
|Data de vencimento do título que está em processo de baixa
  −
|S
  −
|10
  −
|10
   
|-
 
|-
 
|'''valorDocumento'''
 
|'''valorDocumento'''
−
|Valor do documento original que está em processo de baixa
+
|Valor que representa o título
 
|N
 
|N
 
|
 
|
 
|
 
|
 
|}
 
|}
−
A diferença entre as duas APIs acima é o campo "valorPagamento", caso ele seja informado será obrigatório ter os dados de forma de pagamento e data da ocorrência. Caso não seja informado o valor do pagamento, será feita a tentativa de alterar o titulo com o valor do campo valorDocumento ou dataVencimento.
      
'''Respostas esperadas'''
 
'''Respostas esperadas'''
    
Status 200: Status Processamento: OK
 
Status 200: Status Processamento: OK
−
  −
Status 417: Status Processamento: TITULO_JA_CANCELADO (Quando tenta cancelar um titulo que já foi cancelado)
  −
  −
Status 417: Status Processamento: TITULO_JA_BAIXADO (Quando tenta cancelar um titulo que já foi baixado)
      
Status 417: Status Processamento: TITULO_NAO_EXISTE (Quando o título informado não existe)
 
Status 417: Status Processamento: TITULO_NAO_EXISTE (Quando o título informado não existe)
Linha 2 215: Linha 2 273:  
Body:
 
Body:
   −
{"nossoNumero":"58745876","formaPagamento":"BOLETO","valorPagamento":1100.0,"dataOcorrencia":"11/06/2021"}
+
{"nossoNumero":"58745876","valorDocumento":"1100.0", "dataVencimento":"11/07/2021"}
    
=====Resposta=====
 
=====Resposta=====
Linha 2 223: Linha 2 281:     
   "dados": {
 
   "dados": {
−
  −
       "formaPagamento": "BOLETO",
      
       "nomeSacado": "Aluno teste",
 
       "nomeSacado": "Aluno teste",
Linha 2 236: Linha 2 292:  
       "valorDespesaCobranca": 0.0,
 
       "valorDespesaCobranca": 0.0,
   −
       "valorDocumento": 1000.0,
+
       "valorDocumento": 1100.0,
    
       "valorLiquido": 0.0,
 
       "valorLiquido": 0.0,
Linha 2 246: Linha 2 302:  
       "valorOutrosCreditos": 0.0,
 
       "valorOutrosCreditos": 0.0,
   −
       "valorPagamento": 1100.0,
+
       "dataVencimento": "10/07/2021",
−
 
  −
       "dataOcorrencia": "11/06/2021",
      
       "nossoNumero": "58745876"
 
       "nossoNumero": "58745876"
Linha 2 260: Linha 2 314:  
}
 
}
   −
===Financeiro: Cancela Título.===
+
===Financeiro: Baixa Título.===
−
Método: Delete
+
Método: Post
    
(base)/gestaoescolar/services/financeiro/rest/titulo
 
(base)/gestaoescolar/services/financeiro/rest/titulo
   −
Executa o cancelamento do título
+
{| class="wikitable"
−
 
  −
{| class="wikitable"
   
|'''Atributo'''
 
|'''Atributo'''
 
|'''Descrição'''
 
|'''Descrição'''
Linha 2 279: Linha 2 331:  
|1
 
|1
 
|50
 
|50
−
|}
+
|-
 +
|'''formaPagamento'''
 +
|Forma de pagamento para execução da baixa.
   −
====Respostas esperadas====
+
Valores válidos:
−
Status 200: Status Processamento: OK
     −
Status 417: Status Processamento: TITULO_JA_CANCELADO (Quando tenta cancelar um titulo que já foi cancelado)
+
DINHEIRO, CHEQUE, C_CREDITO,C_DEBITO, BOLETO, DEB_AUTOMATICO,TRANSFERENCIA,  DOC,OUTRO_BAIXA_ADM,DEPOSITO,DUPLICADA, FIES, PREFEITURA,PROUNI,  FOLHA_DE_PGTO, CHEQUE_PRE,PAGAMENTO_ONLINE, PERMUTA, PIX
   −
Status 417: Status Processamento: TITULO_JA_BAIXADO (Quando tenta cancelar um titulo que já foi baixado)
+
|S
−
 
+
|3
−
Status 417: Status Processamento: TITULO_NAO_EXISTE (Quando o título informado não existe)
+
|20
−
 
+
|-
−
tatus 417: Status Processamento: ERRO: Erro genérico de negócio
+
|'''dataOcorrencia'''
−
 
+
|Data de aconteceu a baixa do título, essa data será usada como referência pela baixa no gestão escolar e deve ser incluída,
−
Status  500:  Status Processamento: ERRO
+
|S
−
 
+
|10
−
====Exemplo====
+
|10
 +
|-
 +
|'''valorPagamento'''
 +
|Valor do pagamento que deve ser executado no gestão escolar
 +
|N
 +
|
 +
|
 +
|-
 +
|'''dataVencimento'''
 +
|Data de vencimento do título que está em processo de baixa
 +
|S
 +
|10
 +
|10
 +
|-
 +
|'''valorDocumento'''
 +
|Valor do documento original que está em processo de baixa
 +
|N
 +
|
 +
|
 +
|}
 +
A diferença entre as duas APIs acima é o campo "valorPagamento", caso ele seja informado será obrigatório ter os dados de forma de pagamento e data da ocorrência. Caso não seja informado o valor do pagamento, será feita a tentativa de alterar o titulo com o valor do campo valorDocumento ou dataVencimento.
   −
=====Requisição=====
+
'''Respostas esperadas'''
−
Param:
     −
nossoNumero=[numero]
+
Status 200: Status Processamento: OK
   −
=====Resposta=====
+
Status 417: Status Processamento: TITULO_JA_CANCELADO (Quando tenta cancelar um titulo que já foi cancelado)
−
{
+
 
 +
Status 417: Status Processamento: TITULO_JA_BAIXADO (Quando tenta cancelar um titulo que já foi baixado)
 +
 
 +
Status 417: Status Processamento: TITULO_NAO_EXISTE (Quando o título informado não existe)
 +
 
 +
tatus 417: Status Processamento: ERRO: Erro genérico de negócio
 +
 
 +
Status  500:  Status Processamento: ERRO
 +
 
 +
====Exemplo====
 +
 
 +
=====Requisição=====
 +
Body:
 +
 
 +
{"nossoNumero":"58745876","formaPagamento":"BOLETO","valorPagamento":1100.0,"dataOcorrencia":"11/06/2021"}
 +
 
 +
=====Resposta=====
 +
{
    
   "acao": "Manutenção OK",
 
   "acao": "Manutenção OK",
    
   "dados": {
 
   "dados": {
 +
 +
       "formaPagamento": "BOLETO",
    
       "nomeSacado": "Aluno teste",
 
       "nomeSacado": "Aluno teste",
   −
       "numeroDocumento": 8597756,
+
       "numeroDocumento": 8597757,
    
       "valorAbatimentoConcedido": 0.0,
 
       "valorAbatimentoConcedido": 0.0,
Linha 2 328: Linha 2 419:  
       "valorOutrosCreditos": 0.0,
 
       "valorOutrosCreditos": 0.0,
   −
       "nossoNumero": "58745875"
+
       "valorPagamento": 1100.0,
 +
 
 +
       "dataOcorrencia": "11/06/2021",
 +
 
 +
       "nossoNumero": "58745876"
    
   },
 
   },
Linha 2 338: Linha 2 433:  
}
 
}
   −
===Financeiro: Consulta Títulos.===
+
===Financeiro: Cancela Título.===
−
Método: GET
+
Método: Delete
    
(base)/gestaoescolar/services/financeiro/rest/titulo
 
(base)/gestaoescolar/services/financeiro/rest/titulo
   −
Executa a consulta determinados do título
+
Executa o cancelamento do título  
 +
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|'''Atributo'''
 
|'''Atributo'''
Linha 2 351: Linha 2 447:  
|Máximo
 
|Máximo
 
|-
 
|-
−
|'''skumatricula'''
+
|'''nossoNumero'''
−
|Identificador único da matrícula (padrão) EAD
+
|Número gerado pelo sistema interno que criou o título e que deve ser compartilhado com o Gestão Escolar para que cada interação funcione de forma correta
 
|S
 
|S
 
|1
 
|1
−
|
+
|50
−
|-
+
|}
−
|'''idmatricula'''
+
 
−
|Identifcador interno da matricula
+
====Respostas esperadas====
−
|N
+
Status 200: Status Processamento: OK
−
|
+
 
−
|11
+
Status 417: Status Processamento: TITULO_JA_CANCELADO (Quando tenta cancelar um titulo que já foi cancelado)
−
|-
+
 
−
|'''cpf'''
+
Status 417: Status Processamento: TITULO_JA_BAIXADO (Quando tenta cancelar um titulo que já foi baixado)
−
|CPF do aluno, irá trazer todos os títulos relacionados
+
 
−
|N
+
Status 417: Status Processamento: TITULO_NAO_EXISTE (Quando o título informado não existe)
−
|
  −
|11
  −
|-
  −
|'''rmaluno'''
  −
|Código de RM (registro de matricula) do aluno, só aplicado no filtro se não tiver uma idmatricula informado
  −
|S
  −
|
  −
|
  −
|-
  −
|'''codigocurso'''
  −
|Código do curso, só aplicado quando o rmaluno é informado no filtro
  −
|S
  −
|
  −
|
  −
|-
  −
|'''exibecancelados'''
  −
|Exibe ou não os títulos cancelados , padrão false, informe true para ligar o parâmetro
  −
|S
  −
|
  −
|
  −
|}
  −
Use o parâmetro skumatricula, idinternomatricula ou cpf, caso informe os três, será usado o skumatricula como
     −
padrão e se localizar uma matrícula para o id informado irá retornar os títulos ligados a ela, usando o cpf
+
tatus 417: Status Processamento: ERRO: Erro genérico de negócio
   −
irá retornar os títulos localizados para o aluno para qualquer matrícula. 
+
Status  500:  Status Processamento: ERRO
−
 
  −
O parâmetro skumatricula é referene ao código da matrícula feito em um sistema externo EAD que está ligado ao gestão escolar, ao informar esse código
  −
 
  −
será retornada apenas as títulos referentes a essa matrícula. Se passar o idmatricula, é referente ao identificador interno do Gestão Escolar, utilize a API de consultas de matrículas para obter esse código para usar aqui e informado esse parâmetro será carregado os títulos referentes a essa matrícula. 
  −
 
  −
No caso, o CPF do aluno, quando informado, vai pegar todos os títulos, de qualquer matrícula, que esteja associado ao CPF do aluno
  −
 
  −
====Respostas esperadas====
  −
Status 200: Status Processamento: OK
  −
 
  −
Status  500:  Status Processamento: ERRO
      
====Exemplo====
 
====Exemplo====
Linha 2 409: Linha 2 472:  
Param:
 
Param:
   −
cpf=[numero] ou skumatricula=[numero], exibecancelados=[texto]
+
nossoNumero=[numero]
    
=====Resposta=====
 
=====Resposta=====
−
"acao": "Manutenção OK",
+
{
   −
   "dados": [     
+
   "acao": "Manutenção OK",
   −
       {
+
   "dados": {
   −
           "tituloSituacaoRemote": "ATRASADO",
+
       "nomeSacado": "Aluno teste",
   −
           "dataVencimento": "30/07/2021",
+
       "numeroDocumento": 8597756,
   −
           "nomeSacado": "Luíza da Silva",
+
       "valorAbatimentoConcedido": 0.0,
   −
           "numeroDocumento": 430114,
+
       "valorDescontoConcedido": 0.0,
   −
           "valorDocumento": 1400.02
+
       "valorDespesaCobranca": 0.0,
   −
       },
+
       "valorDocumento": 1000.0,
   −
       {
+
       "valorLiquido": 0.0,
   −
           "tituloSituacaoRemote": "PENDENTE",
+
       "valorMoraMulta": 0.0,
   −
           "dataVencimento": "30/08/2021",
+
       "valorOutrasDespesas": 0.0,
   −
           "nomeSacado": "Luíza da Silva",
+
       "valorOutrosCreditos": 0.0,
   −
           "numeroDocumento": 430092,
+
       "nossoNumero": "58745875"
   −
           "valorDocumento": 1400.02
+
   },
−
 
  −
       }
  −
 
  −
   ],
      
   "response": "OK",
 
   "response": "OK",
Linha 2 452: Linha 2 511:  
}
 
}
   −
===Financeiro: Consulta Títulos alterado no período.===
+
===Financeiro: Consulta Títulos.===
 
Método: GET
 
Método: GET
   −
(base)/gestaoescolar/services/financeiro/rest/tituloalteradosperiodo
+
(base)/gestaoescolar/services/financeiro/rest/titulo
−
 
  −
Executa a consulta determinados do título que foram alterados no período
      +
Executa a consulta determinados do título
 
{| class="wikitable"
 
{| class="wikitable"
 
|'''Atributo'''
 
|'''Atributo'''
Linha 2 466: Linha 2 524:  
|Máximo
 
|Máximo
 
|-
 
|-
−
|'''inicio'''
+
|'''skumatricula'''
−
|Data de inicio da consulta
+
|Identificador único da matrícula (padrão) EAD
 
|S
 
|S
−
|10
+
|1
−
|10
+
|
−
|-
+
|-
−
|'''fim'''
+
|'''idmatricula'''
−
|Data fim da consulta
+
|Identifcador interno da matricula
−
|S
+
|N
−
|10
+
|
−
|10
+
|11
−
|}
+
|-
−
Atenção: O intervalo de datas permitido para consulta é de no máximo 7 dias. Ao não informar o início, caso o fim tenha data,será considerado a mesma data para início e vice versa. Caso as duas datas sejam nulas/vazias, será considerado o dia atual em ambas.
+
|'''cpf'''
 +
|CPF do aluno, irá trazer todos os títulos relacionados
 +
|N
 +
|
 +
|11
 +
|-
 +
|'''rmaluno'''
 +
|Código de RM (registro de matricula) do aluno, só aplicado no filtro se não tiver uma idmatricula informado
 +
|S
 +
|
 +
|
 +
|-
 +
|'''codigocurso'''
 +
|Código do curso, só aplicado quando o rmaluno é informado no filtro
 +
|S
 +
|
 +
|
 +
|-
 +
|'''exibecancelados'''
 +
|Exibe ou não os títulos cancelados , padrão false, informe true para ligar o parâmetro
 +
|S
 +
|
 +
|
 +
|}
 +
Use o parâmetro skumatricula, idinternomatricula ou cpf, caso informe os três, será usado o skumatricula como
 +
 
 +
padrão e se localizar uma matrícula para o id informado irá retornar os títulos ligados a ela, usando o cpf
 +
 
 +
irá retornar os títulos localizados para o aluno para qualquer matrícula. 
 +
 
 +
O parâmetro skumatricula é referene ao código da matrícula feito em um sistema externo EAD que está ligado ao gestão escolar, ao informar esse código
 +
 
 +
será retornada apenas as títulos referentes a essa matrícula. Se passar o idmatricula, é referente ao identificador interno do Gestão Escolar, utilize a API de consultas de matrículas para obter esse código para usar aqui e informado esse parâmetro será carregado os títulos referentes a essa matrícula. 
 +
 
 +
No caso, o CPF do aluno, quando informado, vai pegar todos os títulos, de qualquer matrícula, que esteja associado ao CPF do aluno
 +
 
 +
====Respostas esperadas====
 +
Status 200: Status Processamento: OK
 +
 
 +
Status  500:  Status Processamento: ERRO
 +
 
 +
====Exemplo====
 +
 
 +
=====Requisição=====
 +
Param:
 +
 
 +
cpf=[numero] ou skumatricula=[numero], exibecancelados=[texto]
 +
 
 +
=====Resposta=====
 +
"acao": "Manutenção OK",
 +
 
 +
   "dados": [     
 +
 
 +
       {
 +
 
 +
           "tituloSituacaoRemote": "ATRASADO",
 +
 
 +
           "dataVencimento": "30/07/2021",
 +
 
 +
"codigoIntegracao": "SKU_TESTE",
 +
 
 +
            "codigoMatriculaUnico": "UYJA_HAHHS",
 +
 
 +
           "nomeSacado": "Luíza da Silva",
 +
 
 +
           "numeroDocumento": 430114,
 +
 
 +
           "valorDocumento": 1400.02
 +
 
 +
       },
 +
 
 +
       {
 +
 
 +
           "tituloSituacaoRemote": "PENDENTE",
 +
 
 +
"codigoIntegracao": "SKU_TESTE",
 +
 
 +
            "codigoMatriculaUnico": "UYJA_HAHHS",
 +
 
 +
           "dataVencimento": "30/08/2021",
 +
 
 +
           "nomeSacado": "Luíza da Silva",
 +
 
 +
           "numeroDocumento": 430092,
 +
 
 +
           "valorDocumento": 1400.02
 +
 
 +
       }
 +
 
 +
   ],
 +
 
 +
   "response": "OK",
 +
 
 +
   "statusProcessamento": "OK"
 +
 
 +
}
 +
 
 +
===Financeiro: Consulta Títulos alterado no período===
 +
Método: GET
 +
 
 +
(base)/gestaoescolar/services/financeiro/rest/tituloalteradosperiodo
 +
 
 +
Executa a consulta determinados do título que foram alterados no período
 +
 
 +
{| class="wikitable"
 +
|'''Atributo'''
 +
|'''Descrição'''
 +
|Tipo
 +
|Mínimo
 +
|Máximo
 +
|-
 +
|'''inicio'''
 +
|Data de inicio da consulta
 +
|S
 +
|10
 +
|10
 +
|-
 +
|'''fim'''
 +
|Data fim da consulta
 +
|S
 +
|10
 +
|10
 +
|}
 +
Atenção: O intervalo de datas permitido para consulta é de no máximo 7 dias. Ao não informar o início, caso o fim tenha data,será considerado a mesma data para início e vice versa. Caso as duas datas sejam nulas/vazias, será considerado o dia atual em ambas.
 +
 
 +
====Respostas esperadas====
 +
Status 200: Status Processamento: OK
 +
 
 +
Status 417: Status Processamento: ERRO , caso o intervalo de datas informado seja maior do que 7 dias
 +
 
 +
Status  500:  Status Processamento: ERRO
 +
 
 +
====Exemplo====
 +
 
 +
=====Requisição=====
 +
Param:
 +
 
 +
cpf=[numero] ou skumatricula=[numero], exibecancelados=[texto]
 +
 
 +
=====Resposta=====
 +
"acao": "Manutenção OK",
 +
 
 +
   "dados": [     
 +
 
 +
       {
 +
 
 +
           "tituloSituacaoRemote": "ATRASADO",
 +
 
 +
           "dataVencimento": "30/07/2021",
 +
 
 +
           "nomeSacado": "Luíza da Silva",
 +
 
 +
"pagamentoTerceiroCodigoExterno": "55848848",
 +
 
 +
           "numeroDocumento": 430114,
 +
 
 +
           "valorDocumento": 1400.02
 +
 
 +
       },
 +
 
 +
       {
 +
 
 +
           "tituloSituacaoRemote": "PENDENTE",
 +
 
 +
           "dataVencimento": "30/08/2021",
 +
 
 +
           "nomeSacado": "Luíza da Silva",
 +
 
 +
"pagamentoTerceiroCodigoExterno": "55848848",
 +
 
 +
           "numeroDocumento": 430092,
 +
 
 +
           "valorDocumento": 1400.02
 +
 
 +
       }
 +
 
 +
   ],
 +
 
 +
   "response": "OK",
 +
 
 +
   "statusProcessamento": "OK"
 +
 
 +
}
 +
 
 +
===Controle de acesso: Envio de eventos de entrada e saída===
 +
Método: POST
 +
 
 +
(base)/gestaoescolar/services/controleacesso/rest/add
 +
 
 +
Insere registros de entrada e saída para alunos. Deve ser enviado um array com 1 ou mais registros.
 +
 
 +
'''<u>Importante: Enviar os eventos na ordem certa, ou seja, ordenado por data/hora. Não pode enviar primeiro a SAÍDA e depois a ENTRADA. Sempre ordenar pela data/hora crescente para enviar.</u>'''
 +
 
 +
{| class="wikitable"
 +
|'''Atributo'''
 +
|'''Descrição'''
 +
|Tipo
 +
|Mínimo
 +
|Máximo
 +
|-
 +
|'''dataHoraOcorrencia'''
 +
|Data e hora do evento. Formato: dd/mm/yyyy HH:mm
 +
|S
 +
|16
 +
|16
 +
|-
 +
|'''descricao'''
 +
|Descrição a ser gravada na ficha do aluno para esse evento. Exemplo: "Registrado por reconhecimento facial"
 +
|S
 +
|1
 +
|20
 +
|-
 +
|'''ra'''
 +
|Deve  ter a String exata que representa a Registro de Matrícula do aluno (rm)
 +
|S
 +
|1
 +
|255
 +
|-
 +
|'''tipoAcessos'''
 +
|Informar "E" para entrada ou "S" para saída
 +
|S
 +
|1
 +
|1
 +
|}
 +
Exemplo de request:
 +
 
 +
[{
 +
 
 +
       "dataHoraOcorrencia": "23/08/2022 13:20",
   −
====Respostas esperadas====
+
       "descricao": "Registrado por reconhecimento facial",
−
Status 200: Status Processamento: OK
     −
Status 417: Status Processamento: ERRO , caso o intervalo de datas informado seja maior do que 7 dias
+
       "ra": "1655",
   −
Status  500:  Status Processamento: ERRO
+
       "tipoAcessos": "S"
   −
====Exemplo====
+
   },
−
 
  −
=====Requisição=====
  −
Param:
  −
 
  −
cpf=[numero] ou skumatricula=[numero], exibecancelados=[texto]
  −
 
  −
=====Resposta=====
  −
"acao": "Manutenção OK",
  −
 
  −
   "dados": [     
  −
 
  −
       {
  −
 
  −
           "tituloSituacaoRemote": "ATRASADO",
  −
 
  −
           "dataVencimento": "30/07/2021",
  −
 
  −
           "nomeSacado": "Luíza da Silva",
     −
"pagamentoTerceiroCodigoExterno": "55848848",
+
   {
   −
           "numeroDocumento": 430114,
+
       "dataHoraOcorrencia": "23/08/2022 13:13",
   −
           "valorDocumento": 1400.02
+
       "descricao": "Registrado por reconhecimento facial",
   −
       },
+
       "ra": "2726",
   −
       {
+
       "tipoAcessos": "E"
   −
           "tituloSituacaoRemote": "PENDENTE",
+
   }
−
 
  −
           "dataVencimento": "30/08/2021",
  −
 
  −
           "nomeSacado": "Luíza da Silva",
  −
 
  −
"pagamentoTerceiroCodigoExterno": "55848848",
  −
 
  −
           "numeroDocumento": 430092,
  −
 
  −
           "valorDocumento": 1400.02
  −
 
  −
       }
  −
 
  −
   ],
  −
 
  −
   "response": "OK",
  −
 
  −
   "statusProcessamento": "OK"
  −
 
  −
}
      +
]
 
----
 
----
 
----
 
----
 
[[Category:GestaoEscolar]]
 
[[Category:GestaoEscolar]]
 
[[Category:API]]
 
[[Category:API]]
Wescley
privado
180

edições

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

Menu de navegação