API v2.0 - Quizzes Documentation

POST /quizzes/getQuizzes

Gets data for all quizzes, paginated, which can be searched, filtered, and sorted

Query Parameters

Request Body

sortBy — Optional — enum

The field to sort the result set by.

Possible Values:

title
default_passing_score
author

sortDirection — Optional — enum

Direction in which to sort the result set by 'sortBy'. Defaults to ASC.

Possible Values:

ASC
DESC

offset — Optional — integer

The number of quizzes to skip from the beginning. Defaults to 0.

limit — Optional — integer

The maximum number of quizzes to include in the response. Range: [1, 20]. Defaults to 20.

searchTerm — Optional — string

If provided, filters the result set where the title includes the given search term.

filters.guideid — Optional — integer

If provided, filters the result to quizzes of the given guide id.

Response

Status: 200 Ok

[
    {
        "quizid": 2,
        "learnosityid": "3a85bb7b-a9c4-4883-95b5-3db533b75571",
        "title": "Title",
        "default_passing_score": 75,
        "created_date": 1686850353,
        "author": 3,
        "guides": [
            {
                "tile": "Guide Title",
                "guideid": 1
            }
        ]
    }
]

POST /quizzes/import

Creates a new Quiz from a SurveyJS JSON output

GET /quizzes/:quizid

Gets the SurveyJS readable JSON for the provided `quizid`

Route Parameters

:quizid — Required — postive integer: Identifier for the Quiz
includeAnswers — Optional — bool: If true, the response will include the correct answer value for each question. Defaults to false.
quizRevisionid — Optional — positive integer: If provided, will return the quiz JSON for that Quiz Revision.

Response

Status: 200 OK

{
    "quiz": {
        "quizid": 20,
        "quiz_revisionid": 20,
        "created_date": 1703099104,
        "author": 29,
        "deleted": 0
    },
    "guide_quiz_revisions": [],
    "quiz_revision": {
        "quiz_revisionid": 20,
        "modified_by": 29,
        "title": "dF3OXSBG45VhFhp",
        "description": "John the impressed pink spider",
        "passing_score": 70,
        "deleted": 0,
        "date": 0
    },
    "questions": [
        {
            "questionid": 58,
            "quizid": 20,
            "quiz_revisionid": 20,
            "name": "testQuestion",
            "type": "text",
            "question_json": "{\n\"name\": \"testQuestion\",\n\"type\": \"text\",\n\"inputType\": \"number\",\n\"min\": 0,\n\"max\": 100,\n\"title\": \"How many planets are there?\"\n}",
            "answer_json": "8",
            "created_date": 1703099104,
            "page": 0,
            "page_order": 0
        },
        {
            "questionid": 59,
            "quizid": 20,
            "quiz_revisionid": 20,
            "name": "testQuestion2",
            "type": "text",
            "question_json": "{\n\"name\": \"testQuestion2\",\n\"type\": \"text\",\n\"inputType\": \"number\",\n\"title\": \"How many hearts does an Octopus have?\"\n}",
            "answer_json": "3",
            "created_date": 1703099104,
            "page": 0,
            "page_order": 1
        },
        {
            "questionid": 60,
            "quizid": 20,
            "quiz_revisionid": 20,
            "name": "testQuestion3",
            "type": "radiogroup",
            "question_json": "{\n\"name\": \"testQuestion3\",\n\"type\": \"radiogroup\",\n\"title\": \"What is the largest desert in the world?\",\n\"choices\": [\"Gobi\", \"Sahara\", \"Antarctica\"]\n}",
            "answer_json": "\"Antarctica\"",
            "created_date": 1703099104,
            "page": 1,
            "page_order": 0
        }
    ],
    "quiz_json": {
        "title": "dF3OXSBG45VhFhp",
        "description": "John the impressed pink spider",
        "pages": [
            {
                "elements": [
                    {
                        "name": "testQuestion",
                        "type": "text",
                        "inputType": "number",
                        "min": 0,
                        "max": 100,
                        "title": "How many planets are there?",
                        "correctAnswer": 8
                    },
                    {
                        "name": "testQuestion2",
                        "type": "text",
                        "inputType": "number",
                        "title": "How many hearts does an Octopus have?",
                        "correctAnswer": 3
                    }
                ]
            },
            {
                "elements": [
                    {
                        "name": "testQuestion3",
                        "type": "radiogroup",
                        "title": "What is the largest desert in the world?",
                        "choices": [
                            "Gobi",
                            "Sahara",
                            "Antarctica"
                        ],
                        "correctAnswer": "Antarctica"
                    }
                ]
            }
        ]
    }
}

POST /quizzes/delete

Deletes quiz and quiz revision for each valid quiz id provided

POST /quizzes/attach/guide

Create a new revision for the guide and save a new guide_quiz_revision with the new guide_revisionid and the current quiz_revisionid

POST /quizzes/attach/wiki

Save a new wiki_quiz_revision with the current wiki_revisionid and the current quiz_revisionid

POST /quizzes/sessions/save

Create a new session for the user with the given quizid if no session exists or update the response_json if a session already exists for the user with the given quizid

POST /quizzes/sessions/submit

Saves a quiz session once the quiz has been completed.

POST /quizzes/sessions/cancel

Cancel a session for the user with the given quizid, if no session exists return simply ok, if session exists update the cancelled and end_date

GET /quizzes/submissions/:sessionid

Returns the Quiz results for the given Quiz sessionid

GET /quizzes/sessions

Get all quiz sessions limited to what a user has access to. If admin: All sessions, if User: Their own sessions, and if Team Owner: Their own submissions and submissions for all team members

Query Parameters

offset — Optional — positive integer: The number of quiz sessions to skip from the beginning. Defaults to 0.
limit — Optional — positive integer: The maximum number of quiz sessions to include in the response. Range: [1, 200]. Defaults to 20.
direction — Optional — enum: Which direction to sort the list in. Must be "ASC" or "DESC". Defaults to "DESC".
orderby — Optional — enum: Which property to sort the list in. Can be: username, quiz_title, guide_title, last_modified, status. Defaults to "last_modified".
showMyQuizzes — Optional — boolean: Property who defines if will filter by your own quizzes. Must be "true" or "false". Defaults to "false".
teamid — Optional — positive integer: Property who defines if will filter by team id.
query — Optional — string: Search by username and email.

Response

Status: 200 OK

{
    "hasMore": false,
    "quizSessions": [
        {
            "quiz_sessionid": 1,
            "userid": 3,
            "quizid": 1,
            "quiz_revisionid": 1,
            "response_json": "{'question1': '18', 'question2': 'California', 'question3': 'purple'}",
            "init_date": 1702666437,
            "end_date": null,
            "score": null,
            "passed": null,
            "cancelled": null
        }
    ]
}

POST /quizzes/sessions/bulkCancel

Cancel multiple quiz sessions at one time. Must be an Admin or Team Owner to bulk cancel quiz sessions. Returns an array containing the `quiz_sessionid` for all successfully cancelled sessions and an array containing any invalid ids.

PATCH /quizzes/sessions/userInvalidateAll/:userid

Force invalidate multiple documents for a user. Requires admin privilege.

Reference Implementations

Official Apps

Third-party Apps

Third-party Libraries

API Versions

Quizzes

POST /quizzes/getQuizzes

Query Parameters

Request Body

Response

POST /quizzes/import

Request Body

Response

GET /quizzes/:quizid

Route Parameters

Response

POST /quizzes/delete

Request Body

Response

POST /quizzes/attach/guide

Request Body

Response

POST /quizzes/attach/wiki

Request Body

Response

POST /quizzes/sessions/save

Request Body

Response

POST /quizzes/sessions/submit

Request Body

Response

POST /quizzes/sessions/cancel

Request Body

Response

GET /quizzes/submissions/:sessionid

Route Parameters

Response

GET /quizzes/sessions

Query Parameters

Response

POST /quizzes/sessions/bulkCancel

Request Body

Response

PATCH /quizzes/sessions/userInvalidateAll/:userid

Route Parameters

Request Body

Response