Quiz

Gets a page of quizzes discovered on an assessment tool (LMS).

Changed on

The quiz lookup runs asynchronously on the LMS: while the returned page's 'complete' flag is false, only a partial result set is available and the same page should be polled again.

get/admin-api/v1/quiz

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/admin-api/v1/quiz
  • Auth: oauth (defined in the document in a form this page cannot read)

Query parameters

namestring

Filters quizzes by name.

start_timestamp_millisinteger

Filters quizzes by start time; unix timestamp in milliseconds.

lms_setupinteger

Identifier of the assessment tool (LMS setup) to discover quizzes on.

force_new_searchboolean

Forces a new LMS lookup instead of serving the cached result of the previous search.

institutionIdinteger
page_numberinteger
page_sizeinteger
sortstring

Response

OK

number_of_pagesinteger

The number of available pages for the specified page size.

page_numberinteger

The actual page number. Starting with 1.

page_sizeinteger

The the actual size of a page

sortstring

The page sort column name

completeboolean

Example response

{
  "content": [
    {
      "quiz_id": "quiz10",
      "institutionId": 1,
      "lms_setup_id": 1,
      "lms_setup_type": "MOODLE",
      "quiz_name": "Semester End Quiz"
    }
  ]
}

Changes

    • warning

      deleted the query request parameter allRequestParams

    • info

      api operation id getQuizPage removed and replaced with getQuizzes

    • info

      api tag Quiz added

    • info

      api tag quiz-controller removed

    • info

      added the new optional query request parameter force_new_search

    • info

      added the new optional query request parameter lms_setup

    • info

      added the new optional query request parameter name

    • info

      added the new optional query request parameter start_timestamp_millis

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status