Update Quiz - MSAAQ Documentation

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Accept

string

required

Example:

application/json

X-Tenant

string

required

Example:

Body Params application/json

title

string

optional

The title of the quiz.

summary

string

optional

A brief description or summary of the quiz content or purpose.

premium

boolean

optional

Indicates whether the quiz is a premium quiz (true) or not (false).

sort

integer

optional

The order of the quiz when displayed in a list.

meta

object

optional

Additional metadata for the quiz configuration.

randomised

boolean

optional

Determines if the quiz questions should be presented in random order (true) or not (false).

show_results

boolean

optional

Indicates whether the results should be displayed after completion of the quiz.

show_results_at_end

boolean

optional

Specifies whether to show results only at the end of the quiz.

allow_question_navigation

boolean

optional

Allows the user to navigate between questions during the quiz (true) or not (false).

allow_retake

boolean

required

Indicates whether retaking the quiz is allowed.

duration

integer

optional

The total duration of the quiz in minutes. 0 means no time limit.

passing_score

integer

optional

The score required to pass the quiz. A value of 0 means no passing score is required.

question_count

integer

optional

The total number of questions in the quiz.

start_at

string <date-time>

optional

The date and time when the quiz will start (UTC date-time).

end_at

string <date-time>

optional

The date and time when the quiz will end (UTC date-time).

timezone

string

optional

The timezone for the quiz's start and end times, e.g., "UTC".

Example

{
  "title": "string",
  "summary": "string",
  "premium": true,
  "sort": 0,
  "meta": {
    "randomised": true,
    "show_results": true,
    "show_results_at_end": true,
    "allow_question_navigation": true,
    "allow_retake": true,
    "duration": 0,
    "passing_score": 0,
    "question_count": 0,
    "start_at": "2019-08-24T14:15:22Z",
    "end_at": "2019-08-24T14:15:22Z",
    "timezone": "string"
  }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PUT 'https://api.msaaq.com/v1/admin/courses/100/chapters/188/contents/583' \
--header 'Accept: application/json' \
--header 'X-Tenant: academy.msaaq.com' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200Success

application/json

Body

object {0}

Example

{}