privado
180
edições
Mudanças
Ir para navegação
Ir para pesquisar
Linha 1:
Linha 1: − + Linha 9:
Linha 9: − + − Gerar token de autenticação + Linha 44:
Linha 44: − + Linha 110:
Linha 110: − + Linha 226:
Linha 226: − + Linha 267:
Linha 267: − + − + − +
Gestão Escolar - API de integração (ver código-fonte)
Edição das 20h40min de 6 de janeiro de 2021
, 20h40min de 6 de janeiro de 2021→Endpoints da API
== Introdução ==
==Introdução==
Cada endpoint executado retorna uma resposta com um wrap contendo:
Cada endpoint executado retorna uma resposta com um wrap contendo:
· Response com o código http (200, 409,417, 500 e 204)
· Response com o código http (200, 409,417, 500 e 204)
== Endpoints da API ==
==Endpoints da API==
==== 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.
Status 500. Caso algum erro interno ocorra durante o processamento
Status 500. Caso algum erro interno ocorra durante o processamento
== 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
}
}
== 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.
}
}
== 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.
|
|
|-
|-
|
|
|
|
|-
|-
|
|
|
|
|-
|-
|
|
|
|
|}
|}