Quiz API
API change historyList of APIs related to Quiz
Get questions for session
Get list of questions displayed for a specific student session of a normal assessment.
Try itRequest
Request URL
Request parameters
-
string
Format - uuid. Session id
-
(optional)string
Format - uuid. Section id if get the question for that section only
-
(optional)string
Accepted populate entities:response (student's responses on the questions), responseWithFeedback (lecturer configured feedback contents for completed session),responseWithMarkAndSectionName (used by Lecturer), tags
Request headers
Request body
Responses
200 OK
Returns List of question information
Representations
{
"type": "array",
"items": {
"description": "base question model, can have multiple variations with additional properties",
"required": [
"text"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Question ID",
"type": "string"
},
"resourceID": {
"format": "uuid",
"description": "ID of the tool or folder which contains this question, could be survey id or module id",
"type": "string"
},
"parentID": {
"format": "uuid",
"description": "parent of the question id, could be section id if it is different from question ID",
"type": "string"
},
"type": {
"description": "type of the question:\r\n\r\nConstant Sum Question - COS\r\n\r\nEssay Question - ESS\r\n\r\nFill-In-The-Blank Question - FIB\r\n\r\nTrue or False Question - TOF\r\n\r\nSingle Selection Question in Radio - MCQ\r\n\r\nSingle Selection Question in Dropdown - SEL\r\n\r\nMultiple Selection Choice Question - MRQ\r\n\r\nMatching Question - MCH\r\n\r\nOridinal Question - ORD\r\n\r\nLikert's Scale Question - LKS\r\n\r\nSemantic Differential Question - SED",
"type": "string"
},
"forAssessment": {
"description": "Whether the question created for assessment",
"type": "boolean"
},
"text": {
"description": "question text",
"type": "string"
},
"solution": {
"description": "question solution or feedback, used for assessment question, which displayed after student completed the assessment",
"type": "string"
},
"publish": {
"description": "indicate whether the question is published",
"type": "boolean"
},
"mark": {
"format": "double",
"description": "question mark, if any",
"maximum": 10000,
"minimum": 0,
"type": "number"
},
"requireRationale": {
"description": "allow student to enter rationale for the answer.",
"type": "boolean"
},
"difficultyLevel": {
"description": "Difficulty level of the question, 0 - Easy, 1 - Normal, 2 - Difficult. Used for assessment question.",
"allOf": [
{
"format": "int32",
"description": "Difficulty level of question",
"enum": [
0,
1,
2,
3
],
"type": "integer"
}
]
},
"videoTimeStamp": {
"format": "float",
"description": "the timestamp(in seconds) set for the in-video quiz",
"maximum": 2147483647,
"minimum": 0,
"type": "number"
},
"createdDate": {
"format": "date-time",
"description": "time when this question is created.",
"type": "string"
},
"lastUpdatedBy": {
"description": "Name of the user who modified the question last time",
"type": "string"
},
"lastUpdatedDate": {
"format": "date-time",
"description": "Last time this question is modified",
"type": "string"
},
"kutags": {
"description": "Last time this question is modified",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"tagName": {
"type": "string"
},
"targetId": {
"format": "uuid",
"type": "string"
},
"rootId": {
"format": "uuid",
"type": "string"
},
"tagType": {
"format": "int32",
"type": "integer"
},
"userId": {
"format": "uuid",
"type": "string"
},
"operationType": {
"type": "string"
}
}
}
}
}
}
}
[
{
"id": "string",
"resourceID": "string",
"parentID": "string",
"type": "string",
"forAssessment": true,
"text": "string",
"solution": "string",
"publish": true,
"mark": 0.0,
"requireRationale": true,
"difficultyLevel": {},
"videoTimeStamp": 0.0,
"createdDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"kutags": [
{
"id": "string",
"tagName": "string",
"targetId": "string",
"rootId": "string",
"tagType": 0,
"userId": "string",
"operationType": "string"
}
]
}
]
{
"type": "array",
"items": {
"description": "base question model, can have multiple variations with additional properties",
"required": [
"text"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Question ID",
"type": "string"
},
"resourceID": {
"format": "uuid",
"description": "ID of the tool or folder which contains this question, could be survey id or module id",
"type": "string"
},
"parentID": {
"format": "uuid",
"description": "parent of the question id, could be section id if it is different from question ID",
"type": "string"
},
"type": {
"description": "type of the question:\r\n\r\nConstant Sum Question - COS\r\n\r\nEssay Question - ESS\r\n\r\nFill-In-The-Blank Question - FIB\r\n\r\nTrue or False Question - TOF\r\n\r\nSingle Selection Question in Radio - MCQ\r\n\r\nSingle Selection Question in Dropdown - SEL\r\n\r\nMultiple Selection Choice Question - MRQ\r\n\r\nMatching Question - MCH\r\n\r\nOridinal Question - ORD\r\n\r\nLikert's Scale Question - LKS\r\n\r\nSemantic Differential Question - SED",
"type": "string"
},
"forAssessment": {
"description": "Whether the question created for assessment",
"type": "boolean"
},
"text": {
"description": "question text",
"type": "string"
},
"solution": {
"description": "question solution or feedback, used for assessment question, which displayed after student completed the assessment",
"type": "string"
},
"publish": {
"description": "indicate whether the question is published",
"type": "boolean"
},
"mark": {
"format": "double",
"description": "question mark, if any",
"maximum": 10000,
"minimum": 0,
"type": "number"
},
"requireRationale": {
"description": "allow student to enter rationale for the answer.",
"type": "boolean"
},
"difficultyLevel": {
"description": "Difficulty level of the question, 0 - Easy, 1 - Normal, 2 - Difficult. Used for assessment question.",
"allOf": [
{
"format": "int32",
"description": "Difficulty level of question",
"enum": [
0,
1,
2,
3
],
"type": "integer"
}
]
},
"videoTimeStamp": {
"format": "float",
"description": "the timestamp(in seconds) set for the in-video quiz",
"maximum": 2147483647,
"minimum": 0,
"type": "number"
},
"createdDate": {
"format": "date-time",
"description": "time when this question is created.",
"type": "string"
},
"lastUpdatedBy": {
"description": "Name of the user who modified the question last time",
"type": "string"
},
"lastUpdatedDate": {
"format": "date-time",
"description": "Last time this question is modified",
"type": "string"
},
"kutags": {
"description": "Last time this question is modified",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"tagName": {
"type": "string"
},
"targetId": {
"format": "uuid",
"type": "string"
},
"rootId": {
"format": "uuid",
"type": "string"
},
"tagType": {
"format": "int32",
"type": "integer"
},
"userId": {
"format": "uuid",
"type": "string"
},
"operationType": {
"type": "string"
}
}
}
}
}
}
}
[
{
"id": "string",
"resourceID": "string",
"parentID": "string",
"type": "string",
"forAssessment": true,
"text": "string",
"solution": "string",
"publish": true,
"mark": 0.0,
"requireRationale": true,
"difficultyLevel": {},
"videoTimeStamp": 0.0,
"createdDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"kutags": [
{
"id": "string",
"tagName": "string",
"targetId": "string",
"rootId": "string",
"tagType": 0,
"userId": "string",
"operationType": "string"
}
]
}
]
{
"type": "array",
"items": {
"description": "base question model, can have multiple variations with additional properties",
"required": [
"text"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Question ID",
"type": "string"
},
"resourceID": {
"format": "uuid",
"description": "ID of the tool or folder which contains this question, could be survey id or module id",
"type": "string"
},
"parentID": {
"format": "uuid",
"description": "parent of the question id, could be section id if it is different from question ID",
"type": "string"
},
"type": {
"description": "type of the question:\r\n\r\nConstant Sum Question - COS\r\n\r\nEssay Question - ESS\r\n\r\nFill-In-The-Blank Question - FIB\r\n\r\nTrue or False Question - TOF\r\n\r\nSingle Selection Question in Radio - MCQ\r\n\r\nSingle Selection Question in Dropdown - SEL\r\n\r\nMultiple Selection Choice Question - MRQ\r\n\r\nMatching Question - MCH\r\n\r\nOridinal Question - ORD\r\n\r\nLikert's Scale Question - LKS\r\n\r\nSemantic Differential Question - SED",
"type": "string"
},
"forAssessment": {
"description": "Whether the question created for assessment",
"type": "boolean"
},
"text": {
"description": "question text",
"type": "string"
},
"solution": {
"description": "question solution or feedback, used for assessment question, which displayed after student completed the assessment",
"type": "string"
},
"publish": {
"description": "indicate whether the question is published",
"type": "boolean"
},
"mark": {
"format": "double",
"description": "question mark, if any",
"maximum": 10000,
"minimum": 0,
"type": "number"
},
"requireRationale": {
"description": "allow student to enter rationale for the answer.",
"type": "boolean"
},
"difficultyLevel": {
"description": "Difficulty level of the question, 0 - Easy, 1 - Normal, 2 - Difficult. Used for assessment question.",
"allOf": [
{
"format": "int32",
"description": "Difficulty level of question",
"enum": [
0,
1,
2,
3
],
"type": "integer"
}
]
},
"videoTimeStamp": {
"format": "float",
"description": "the timestamp(in seconds) set for the in-video quiz",
"maximum": 2147483647,
"minimum": 0,
"type": "number"
},
"createdDate": {
"format": "date-time",
"description": "time when this question is created.",
"type": "string"
},
"lastUpdatedBy": {
"description": "Name of the user who modified the question last time",
"type": "string"
},
"lastUpdatedDate": {
"format": "date-time",
"description": "Last time this question is modified",
"type": "string"
},
"kutags": {
"description": "Last time this question is modified",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"tagName": {
"type": "string"
},
"targetId": {
"format": "uuid",
"type": "string"
},
"rootId": {
"format": "uuid",
"type": "string"
},
"tagType": {
"format": "int32",
"type": "integer"
},
"userId": {
"format": "uuid",
"type": "string"
},
"operationType": {
"type": "string"
}
}
}
}
}
}
}
400 Bad Request
Bad Request
Representations
{
"type": "string"
}
string
{
"type": "string"
}
string
{
"type": "string"
}
403 Forbidden
Login user not authorized to perform this action.
Representations
{
"type": "string"
}
string
{
"type": "string"
}
string
{
"type": "string"
}
500 Internal Server Error
Server Error
Representations
{
"type": "string"
}
string
{
"type": "string"
}
string
{
"type": "string"
}
Code samples
@ECHO OFF
curl -v -X GET "https://luminus.azure-api.net/assessment/session/{id}/question?SectionID={string}&populate={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["SectionID"] = "{string}";
queryString["populate"] = "{string}";
var uri = "https://luminus.azure-api.net/assessment/session/{id}/question?" + queryString;
var response = await client.GetAsync(uri);
}
}
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://luminus.azure-api.net/assessment/session/{id}/question");
builder.setParameter("SectionID", "{string}");
builder.setParameter("populate", "{string}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"SectionID": "{string}",
"populate": "{string}",
};
$.ajax({
url: "https://luminus.azure-api.net/assessment/session/{id}/question?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://luminus.azure-api.net/assessment/session/{id}/question";
NSArray* array = @[
// Request parameters
@"entities=true",
@"SectionID={string}",
@"populate={string}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://luminus.azure-api.net/assessment/session/{id}/question');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'SectionID' => '{string}',
'populate' => '{string}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>
########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'SectionID': '{string}',
'populate': '{string}',
})
try:
conn = httplib.HTTPSConnection('luminus.azure-api.net')
conn.request("GET", "/assessment/session/{id}/question?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'SectionID': '{string}',
'populate': '{string}',
})
try:
conn = http.client.HTTPSConnection('luminus.azure-api.net')
conn.request("GET", "/assessment/session/{id}/question?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
require 'net/http'
uri = URI('https://luminus.azure-api.net/assessment/session/{id}/question')
query = URI.encode_www_form({
# Request parameters
'SectionID' => '{string}',
'populate' => '{string}'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body