API - PETComputacaoUFPR/Titanic GitHub Wiki
Todas as urls da API são precedidas pela versão. A atual é /api/v1
URL | GET | POST | PUT | DELETE |
---|---|---|---|---|
/materias | Retorna 200 e todas as matérias cadastradas | Retorna 200 ao cadastrar uma matéria, 409 ao dar erro na inserção e 403 se não é um moderador que está acessando essa url | 404 | 404 |
/materias/:codigo | Retorna 200 e a matéria com o código | 404 | Retorna 200 ao atualizar uma matéria, 409 ao dar erro na atualização e 403 se não é um moderador que está acessando essa url | Retorna 200 se a matéria foi deletada, 409 ao dar erro na remoção e 403 se não é um moderador que está acessando essa url |
/materias/search/:nome/:codigo | Retorna 200 e a lista de matérias com nome e/ou código | 404 | 404 | 404 |
/professores | Retorna 200 e todos os professores cadastrados | Retorna 200 ao cadastrar um professor, 409 ao dar erro na inserção e 403 se não é um moderador que está acessando essa url | 404 | 404 |
/professores/:id | Retorna 200 e o professor com o id | 404 | Retorna 200 ao atualizar um professor, 409 ao dar erro na atualização e 403 se não é um moderador que está acessando essa url | Retorna 200 se o professor foi deletado, 409 ao dar erro na remoção e 403 se não é um moderador que está acessando essa url |
/professores/search/:nome | Retorna 200 e a lista de professores com nome | 404 | 404 | 404 |
/usuarios | Retorna 200 e todos os usuários cadastrados | Retorna 200 ao cadastrar um usuário, 409 ao dar erro na inserção e 403 se não é um moderador que está acessando essa url | 404 | 404 |
/professores/:id | Retorna 200 e o usuário com o id | 404 | Retorna 200 ao atualizar um usuário, 409 ao dar erro na atualização e 403 se não é um moderador que está acessando essa url | Retorna 200 se o usuário foi deletado, 409 ao dar erro na remoção e 403 se não é um moderador que está acessando essa url |
/usuarios/search/:nome | Retorna 200 e a lista de usuarios com nome | 404 | 404 | 404 |