Pular para o conteúdo principal

Questões do banco

Questões do banco de questões e as opções de resposta de cada questão. Corresponde à aba Questões do banco, da tela Banco de questões. Os valores de tipo, pontuação, feedback e tempo de feedback são informados pelos ids das listas de apoio.

Endpoints​

MétodoCaminhoDescrição
POST/operational/question-banks/{question_bank_uuid}/questionsCadastra uma questão no banco
GET/operational/question-banks/{question_bank_uuid}/questions/{id}Consulta uma questão, com as opções
PUT/operational/question-banks/{question_bank_uuid}/questions/{id}Altera uma questão
DELETE/operational/question-banks/{question_bank_uuid}/questions/{id}Apaga uma questão
GET/operational/question-banks/{question_bank_uuid}/questions/{question_id}/optionsLista as opções de uma questão
POST/operational/question-banks/{question_bank_uuid}/questions/{question_id}/optionsCadastra uma opção na questão
GET/operational/question-banks/{question_bank_uuid}/questions/{question_id}/options/{id}Consulta uma opção
PUT/operational/question-banks/{question_bank_uuid}/questions/{question_id}/options/{id}Altera uma opção
DELETE/operational/question-banks/{question_bank_uuid}/questions/{question_id}/options/{id}Apaga uma opção

POST /operational/question-banks/{question_bank_uuid}/questions​

Cadastra uma questão no banco de questões.

Parâmetros de URL

ParâmetroDescrição
question_bank_uuiduuid do banco de questões

Corpo

CampoObrigatórioTipoDescrição
question_textSimtextoTexto da questão
question_type_idSimnúmero inteiroTipo da questão (lista de tipos)
scoring_mode_idSimnúmero inteiroModo de pontuação (lista de modos de pontuação)
feedback_mode_idSimnúmero inteiroModo de feedback (lista de modos de feedback)
feedback_timing_idSimnúmero inteiroTempo de feedback (lista de tempos de feedback)
shuffle_optionsNãobooleanoEmbaralha a ordem das opções para o aluno
max_scoreNãonúmero, de 0 a 999999,99Pontuação máxima da questão
feedback_textNãotextoTexto de feedback geral da questão
explanation_textNãotextoTexto explicativo da questão

Resposta: 200 OK, com a questão criada. Dados inválidos: 422, com message e errors.

curl -X POST "https://api.pedagogo.app/operational/question-banks/<uuid-do-banco>/questions" \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"question_text": "Questão exemplo", "question_type_id": 1, "scoring_mode_id": 1, "feedback_mode_id": 1, "feedback_timing_id": 1, "max_score": 10}'

GET /operational/question-banks/{question_bank_uuid}/questions/{id}​

Consulta uma questão do banco.

Parâmetros de URL

ParâmetroDescrição
question_bank_uuiduuid do banco de questões
idid da questão

Resposta: 200 OK, com os campos da questão e as relações questionBank, questionType, scoringMode, feedbackMode, feedbackTiming, options, userCreate e userUpdate.

PUT /operational/question-banks/{question_bank_uuid}/questions/{id}​

Altera uma questão. Envie apenas os campos que devem mudar.

Parâmetros de URL

ParâmetroDescrição
question_bank_uuiduuid do banco de questões
idid da questão

Corpo

CampoObrigatórioTipoDescrição
question_textNãotextoTexto da questão. Se enviado, não pode ficar vazio
question_type_idNãonúmero inteiroTipo da questão. Se enviado, precisa ser um id válido
scoring_mode_idNãonúmero inteiroModo de pontuação. Se enviado, precisa ser um id válido
feedback_mode_idNãonúmero inteiroModo de feedback. Se enviado, precisa ser um id válido
feedback_timing_idNãonúmero inteiroTempo de feedback. Se enviado, precisa ser um id válido
shuffle_optionsNãobooleanoEmbaralha a ordem das opções para o aluno
max_scoreNãonúmero, de 0 a 999999,99Pontuação máxima da questão
feedback_textNãotextoTexto de feedback geral da questão
explanation_textNãotextoTexto explicativo da questão

Resposta: 200 OK, com a questão alterada.

DELETE /operational/question-banks/{question_bank_uuid}/questions/{id}​

Apaga uma questão do banco.

Parâmetros de URL

ParâmetroDescrição
question_bank_uuiduuid do banco de questões
idid da questão

Resposta: 200 OK. O corpo traz apenas o resultado da exclusão, sem mensagem.

GET /operational/question-banks/{question_bank_uuid}/questions/{question_id}/options​

Lista as opções de uma questão.

Parâmetros de URL

ParâmetroDescrição
question_bank_uuiduuid do banco de questões
question_idid da questão

Parâmetros de URL (query)

ParâmetroDescrição
per_pageQuantidade de registros por página
pageNúmero da página, quando per_page é informado
column e orderOrdenação pela coluna informada, na direção asc ou desc

Resposta: 200 OK, uma lista (ou lista paginada, com per_page). Campos: id, question_id, option_key, option_text, order, is_correct, score_delta e created_at.

POST /operational/question-banks/{question_bank_uuid}/questions/{question_id}/options​

Cadastra uma opção de resposta na questão.

Parâmetros de URL

ParâmetroDescrição
question_bank_uuiduuid do banco de questões
question_idid da questão

Corpo

CampoObrigatórioTipoDescrição
option_textSimtextoTexto da opção
orderSimnúmero inteiro, zero ou maiorPosição da opção
option_keyNãotexto, até 10 caracteresLetra ou identificação da opção, por exemplo A, B, C, T ou F
is_correctNãobooleanoMarca se a opção é a resposta correta
score_deltaNãonúmero, de -999999,99 a 999999,99Pontos da opção
feedback_textNãotextoFeedback da opção
explanation_textNãotextoExplicação da opção

Resposta: 200 OK, com a opção criada.

GET /operational/question-banks/{question_bank_uuid}/questions/{question_id}/options/{id}​

Consulta uma opção da questão.

Parâmetros de URL

ParâmetroDescrição
question_bank_uuiduuid do banco de questões
question_idid da questão
idid da opção

Resposta: 200 OK, com os campos da opção e as relações question, userCreate e userUpdate.

PUT /operational/question-banks/{question_bank_uuid}/questions/{question_id}/options/{id}​

Altera uma opção da questão. Envie apenas os campos que devem mudar.

Parâmetros de URL

ParâmetroDescrição
question_bank_uuiduuid do banco de questões
question_idid da questão
idid da opção

Corpo

CampoObrigatórioTipoDescrição
option_textNãotextoTexto da opção. Se enviado, não pode ficar vazio
orderNãonúmero inteiro, zero ou maiorPosição da opção. Se enviado, não pode ficar vazio
option_keyNãotexto, até 10 caracteresLetra ou identificação da opção
is_correctNãobooleanoMarca se a opção é a resposta correta
score_deltaNãonúmero, de -999999,99 a 999999,99Pontos da opção
feedback_textNãotextoFeedback da opção
explanation_textNãotextoExplicação da opção

Resposta: 200 OK, com a opção alterada.

DELETE /operational/question-banks/{question_bank_uuid}/questions/{question_id}/options/{id}​

Apaga uma opção da questão.

Parâmetros de URL

ParâmetroDescrição
question_bank_uuiduuid do banco de questões
question_idid da questão
idid da opção

Resposta: 200 OK. O corpo traz apenas o resultado da exclusão, sem mensagem.