ipr.question.get

Scope: ipr

Кто может вызывать: Право на связанный тест/курс (canManageCourse) либо на урок вопроса; привилегированные — без ограничений. Подробнее: Модель доступа

Возвращает вопрос по ID вместе с вариантами ответов.

HTTP: GET

Побочные эффекты: none

Параметры метода

Параметр Тип Обяз. Описание
id (алиас questionId) int да ID вопроса
testId int нет ID теста для проверки принадлежности вопроса и прав. Если не передан — права проверяются через урок вопроса

Возвращаемые данные

Поле Тип Описание
id int ID вопроса
title string Текст вопроса
description string Дополнительное описание/пояснение
testId int|null ID теста (если был передан или определён)
lessonId int ID урока вопроса
type string S | M | T | R
active bool Активность
sort int Сортировка
point int Балл за верный ответ
answers array Варианты ответов, см. ниже

Структура answers[]

Поле Тип Описание
id int ID варианта ответа
text string Текст варианта
correct bool Правильный ли вариант
sort int Сортировка

Обработка ошибок

Справочник кодов: error-codes.md.

Код Описание
UNAUTHORIZED Пользователь не авторизован
VALIDATION_ERROR id не передан, либо вопрос не относится к указанному testId
NOT_FOUND Вопрос или testId не найдены
PERMISSION_DENIED Нет прав на связанный тест/курс/урок
INTERNAL_ERROR Внутренняя ошибка сервера

Пример запроса (GET)

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/ipr.question.get.json"
          -H "Accept: application/json"
          --data-urlencode "id=501"

Пример ответа

{
          "result": {
            "result": {
              "id": 501,
              "title": "Что из перечисленного относится к принципам обратной связи?",
              "description": "",
              "testId": 44,
              "lessonId": 905,
              "type": "M",
              "active": true,
              "sort": 100,
              "point": 2,
              "answers": [
                { "id": 1, "text": "Своевременность", "correct": true, "sort": 10 },
                { "id": 2, "text": "Анонимность автора", "correct": false, "sort": 20 }
              ]
            },
            "total": null,
            "next": null,
            "error": null
          }
        }

См. также

Предыдущая
ipr.question.list
Следующая
ipr.question.add