privado
180
edições
Mudanças
De UltramaxWiki
Gestão Escolar - API de integração (ver código-fonte)
Edição das 16h09min de 12 de junho de 2021
, 16h09min de 12 de junho de 2021→Financeiro: Baixa Título.
===Gerar token de autenticação===
===Gerar token de autenticação===
Gera um token de autenticação para acessar os recursos da API de Integração do gestão escolar. Este token deve ser utilizado para consumir os demais endpoints.
Gera um token de autenticação para acessar os recursos da API de Integração do gestão escolar. Este token deve ser utilizado para consumir os demais endpoints.
Método: Post
(base)/gestaoescolar/services/login/login/autentica
(base)/gestaoescolar/services/login/login/autentica
===Manutenção de cursos===
===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
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
Método: Post
(base)/gestaoescolar/services/curso/rest/add
(base)/gestaoescolar/services/curso/rest/add
===Manutenção de alunos===
===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.
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
(base)/gestaoescolar/services/aluno/rest/responsavelfinanceiro
===Manutenção de matrículas===
===Manutenção de matrículas===
Adiciona ou altera uma matrícula. Pelo código da matrícula único, código de integração entre os sistemas, será possível atualizar os dados de uma matrícula, caso ela exista, ou incluir uma nova.
Adiciona ou altera uma matrícula. Pelo código da matrícula único, código de integração entre os sistemas, será possível atualizar os dados de uma matrícula, caso ela exista, ou incluir uma nova.
Método: Post
(base)/gestaoescolar/services/matricula/rest/add
(base)/gestaoescolar/services/matricula/rest/add
}
}
===Manutenção de Pessoas (PessoaRemote)===
===Manutenção de Pessoas ===
Usado nos dados do aluno para representar uma filiação.
Usado nos dados do aluno para representar uma filiação.
|}
|}
=== Financeiro: Baixa Título. ===
===Financeiro: Baixa Título.===
Método: Post
Método: Post
|}
|}
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.
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.
===Financeiro: Cancela Título.===
Método: Delete
(base)/gestaoescolar/services/aluno/rest/titulo
Executa o cancelamento do título
{| class="wikitable"
|'''Atributo'''
|'''Descrição'''
|Tipo
|Mínimo
|Máximo
|-
|'''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
|S
|1
|50
|}
----
----
[[Category:GestaoEscolar]]
[[Category:GestaoEscolar]]
[[Category:API]]
[[Category:API]]
