Banco de questões
O banco de questões guarda as questões das provas em conjuntos reutilizáveis. Corresponde à tela Banco de questões, do módulo Operacional, com as abas Questões do banco e Cursos do banco. Um banco pode ser vinculado a cursos, e as provas das turmas desses cursos usam o banco vinculado.
Esta página descreve os bancos. Os demais recursos têm páginas próprias:
- Cursos do banco: vínculo entre o banco e os cursos, com os critérios de aprovação.
- Questões do banco: questões e opções de resposta.
- Listas de apoio: tipos de questão, modos de pontuação, modos e tempos de feedback.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /operational/question-banks | Lista os bancos de questões |
| POST | /operational/question-banks | Cria um banco de questões |
| GET | /operational/question-banks/{uuid} | Consulta um banco, com as questões |
| PUT | /operational/question-banks/{uuid} | Altera um banco de questões |
| DELETE | /operational/question-banks/{uuid} | Apaga um banco de questões |
GET /operational/question-banks
Lista os bancos de questões.
Parâmetros de URL (query)
| Parâmetro | Descrição |
|---|---|
| per_page | Quantidade de registros por página |
| page | Número da página, quando per_page é informado |
| column e order | Ordenação pela coluna informada, na direção asc ou desc |
Esta listagem não aplica o parâmetro search.
Resposta: 200 OK, uma lista (ou lista paginada, com per_page). Campos: id, uuid, title, description, is_active e created_at.
curl -X GET "https://api.pedagogo.app/operational/question-banks?per_page=15" \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Accept: application/json"
POST /operational/question-banks
Cria um banco de questões. O uuid é gerado pela API.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| title | Sim | texto, até 255 caracteres | Nome do banco de questões |
| description | Não | texto | Descrição do banco |
| is_active | Não | booleano | Marca se o banco está ativo |
Resposta: 200 OK, com o banco criado, incluindo o uuid. Dados inválidos: 422, com message e errors (veja Convenções).
curl -X POST "https://api.pedagogo.app/operational/question-banks" \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"title": "Banco exemplo", "description": "Questões de exemplo", "is_active": true}'
GET /operational/question-banks/{uuid}
Consulta um banco de questões, com as questões cadastradas.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| uuid | uuid do banco de questões |
Resposta: 200 OK, com os campos do banco e as relações questions, userCreate e userUpdate.
PUT /operational/question-banks/{uuid}
Altera um banco de questões. Envie apenas os campos que devem mudar.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| uuid | uuid do banco de questões |
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| title | Não | texto, até 255 caracteres | Nome do banco. Se enviado, não pode ficar vazio |
| description | Não | texto | Descrição do banco |
| is_active | Não | booleano | Marca se o banco está ativo |
Resposta: 200 OK, com o banco alterado.
DELETE /operational/question-banks/{uuid}
Apaga o banco de questões por exclusão lógica. Os vínculos com cursos e as questões do banco não são apagados por esta ação.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| uuid | uuid do banco de questões |
Resposta: 200 OK. O corpo traz apenas o resultado da exclusão, sem mensagem.