Quiz API
API change historyList of APIs related to Quiz
Request
Request URL
Request parameters
-
string
Format - uuid. Assessment ID
-
(optional)string
C: All Completed Attempt (default)/ F: First Marked Attempt/ L: Last Marked Attempt/ B: Best Marked Attempt
Request headers
Request body
Responses
200 OK
The analysis result
Representations
{
"description": "Overall Analysis for normal assessment",
"type": "object",
"properties": {
"averageScore": {
"format": "double",
"description": "average value on all scores in class",
"type": "number"
},
"medianScore": {
"format": "double",
"description": "median score on all scores in class",
"type": "number"
},
"standardDev": {
"format": "double",
"description": "standard deviation on all scores in class",
"type": "number"
},
"kR20": {
"format": "double",
"description": "The value range is from 0 to 1, where 0 is no reliability and 1 is perfect reliability. The closer the score is to 1, the more reliable the test. Just what constitites an “acceptable” KR-20 score depends on the type of test. In general, a score of above .5 is usually considered reasonable.\r\nThis statistics is valid when there is no partial correct answers in this test.",
"type": "number"
},
"minScore": {
"format": "double",
"description": "lowest value on all scores in class",
"type": "number"
},
"maxScore": {
"format": "double",
"description": "highest value on all scores in class",
"type": "number"
},
"questions": {
"description": "detailed question analysis",
"type": "array",
"items": {
"description": "analysis for a question",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "question id",
"type": "string"
},
"text": {
"description": "question text",
"type": "string"
},
"type": {
"description": "question type",
"type": "string"
},
"difficultyLevel": {
"description": "difficulty level of the question",
"allOf": [
{
"format": "int32",
"description": "Difficulty level of question",
"enum": [
0,
1,
2,
3
],
"type": "integer"
}
]
},
"averageScore": {
"format": "double",
"description": "average score obtained for this question",
"type": "number"
},
"standardDev": {
"format": "double",
"description": "standard deviation on all scores in this question",
"type": "number"
},
"medianScore": {
"format": "double",
"description": "median score obtained for this question",
"type": "number"
},
"percentile25": {
"format": "double",
"description": "the marks for the 25th percentile threshold obtained from the question",
"type": "number"
},
"percentile75": {
"format": "double",
"description": "the marks for the 75th percentile threshold obtained from the question",
"type": "number"
},
"noOfCorrectAnswers": {
"format": "int32",
"description": "number of sessions which has this question answered correctly (has score > 0)",
"type": "integer"
},
"noOfIncorrectAnswers": {
"format": "int32",
"description": "number of sessions which has skipped this question or answered this question wrongly (has score <=0)",
"type": "integer"
},
"ptBiserial": {
"format": "double",
"description": "Point-biserial correlation coefficient",
"type": "number"
},
"correctionRate": {
"format": "double",
"description": "percentage of sessions who has this question answered correctly",
"type": "number",
"readOnly": true
},
"choiceOptions": {
"description": "detailed analysis for options used for choice selection questions",
"type": "array",
"items": {
"description": "detailed analysis for question options used for choice selection questions",
"type": "object",
"properties": {
"text": {
"description": "option text if any",
"type": "string"
},
"noOfStudents": {
"format": "int32",
"description": "number of sessions which has this option selected",
"type": "integer"
},
"selectionRate": {
"format": "double",
"description": "percentage of session which has this option selected",
"type": "number"
},
"averageExamScore": {
"format": "double",
"description": "average score of sessions which has this option selected",
"type": "number"
},
"isCorrect": {
"description": "indicate whether this option is correct",
"type": "boolean"
},
"order": {
"format": "int32",
"description": "option order",
"type": "integer"
}
}
}
},
"options": {
"description": "detailed analysis for question options used for Fill-in-the-blank question and matching question",
"type": "array",
"items": {
"description": "detailed analysis for question options used for Fill-in-the-blank question and matching question",
"type": "object",
"properties": {
"noOfCorrectAnswers": {
"format": "int32",
"description": "number of sessions which has this option/blank answered correctly",
"type": "integer"
},
"noOfIncorrectAnswers": {
"format": "int32",
"description": "number of sessions which has this option/blank answered wrongly",
"type": "integer"
},
"correctionRate": {
"format": "float",
"description": "percentage of sessions who has this option/blank answered correctly",
"type": "number",
"readOnly": true
},
"ptBiserial": {
"format": "double",
"description": "Point-biserial correlation coefficient",
"type": "number"
},
"order": {
"format": "int32",
"description": "blank option order",
"type": "integer"
},
"text": {
"description": "option text if any",
"type": "string"
}
}
}
},
"unmarkedQuestions": {
"format": "int32",
"description": "number of questions which have not been marked. Used for Essay Question",
"type": "integer"
}
}
}
}
}
}{
"averageScore": 0.0,
"medianScore": 0.0,
"standardDev": 0.0,
"kR20": 0.0,
"minScore": 0.0,
"maxScore": 0.0,
"questions": [
{
"id": "string",
"text": "string",
"type": "string",
"difficultyLevel": {},
"averageScore": 0.0,
"standardDev": 0.0,
"medianScore": 0.0,
"percentile25": 0.0,
"percentile75": 0.0,
"noOfCorrectAnswers": 0,
"noOfIncorrectAnswers": 0,
"ptBiserial": 0.0,
"correctionRate": 0.0,
"choiceOptions": [
{
"text": "string",
"noOfStudents": 0,
"selectionRate": 0.0,
"averageExamScore": 0.0,
"isCorrect": true,
"order": 0
}
],
"options": [
{
"noOfCorrectAnswers": 0,
"noOfIncorrectAnswers": 0,
"correctionRate": 0.0,
"ptBiserial": 0.0,
"order": 0,
"text": "string"
}
],
"unmarkedQuestions": 0
}
]
}{
"description": "Overall Analysis for normal assessment",
"type": "object",
"properties": {
"averageScore": {
"format": "double",
"description": "average value on all scores in class",
"type": "number"
},
"medianScore": {
"format": "double",
"description": "median score on all scores in class",
"type": "number"
},
"standardDev": {
"format": "double",
"description": "standard deviation on all scores in class",
"type": "number"
},
"kR20": {
"format": "double",
"description": "The value range is from 0 to 1, where 0 is no reliability and 1 is perfect reliability. The closer the score is to 1, the more reliable the test. Just what constitites an “acceptable” KR-20 score depends on the type of test. In general, a score of above .5 is usually considered reasonable.\r\nThis statistics is valid when there is no partial correct answers in this test.",
"type": "number"
},
"minScore": {
"format": "double",
"description": "lowest value on all scores in class",
"type": "number"
},
"maxScore": {
"format": "double",
"description": "highest value on all scores in class",
"type": "number"
},
"questions": {
"description": "detailed question analysis",
"type": "array",
"items": {
"description": "analysis for a question",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "question id",
"type": "string"
},
"text": {
"description": "question text",
"type": "string"
},
"type": {
"description": "question type",
"type": "string"
},
"difficultyLevel": {
"description": "difficulty level of the question",
"allOf": [
{
"format": "int32",
"description": "Difficulty level of question",
"enum": [
0,
1,
2,
3
],
"type": "integer"
}
]
},
"averageScore": {
"format": "double",
"description": "average score obtained for this question",
"type": "number"
},
"standardDev": {
"format": "double",
"description": "standard deviation on all scores in this question",
"type": "number"
},
"medianScore": {
"format": "double",
"description": "median score obtained for this question",
"type": "number"
},
"percentile25": {
"format": "double",
"description": "the marks for the 25th percentile threshold obtained from the question",
"type": "number"
},
"percentile75": {
"format": "double",
"description": "the marks for the 75th percentile threshold obtained from the question",
"type": "number"
},
"noOfCorrectAnswers": {
"format": "int32",
"description": "number of sessions which has this question answered correctly (has score > 0)",
"type": "integer"
},
"noOfIncorrectAnswers": {
"format": "int32",
"description": "number of sessions which has skipped this question or answered this question wrongly (has score <=0)",
"type": "integer"
},
"ptBiserial": {
"format": "double",
"description": "Point-biserial correlation coefficient",
"type": "number"
},
"correctionRate": {
"format": "double",
"description": "percentage of sessions who has this question answered correctly",
"type": "number",
"readOnly": true
},
"choiceOptions": {
"description": "detailed analysis for options used for choice selection questions",
"type": "array",
"items": {
"description": "detailed analysis for question options used for choice selection questions",
"type": "object",
"properties": {
"text": {
"description": "option text if any",
"type": "string"
},
"noOfStudents": {
"format": "int32",
"description": "number of sessions which has this option selected",
"type": "integer"
},
"selectionRate": {
"format": "double",
"description": "percentage of session which has this option selected",
"type": "number"
},
"averageExamScore": {
"format": "double",
"description": "average score of sessions which has this option selected",
"type": "number"
},
"isCorrect": {
"description": "indicate whether this option is correct",
"type": "boolean"
},
"order": {
"format": "int32",
"description": "option order",
"type": "integer"
}
}
}
},
"options": {
"description": "detailed analysis for question options used for Fill-in-the-blank question and matching question",
"type": "array",
"items": {
"description": "detailed analysis for question options used for Fill-in-the-blank question and matching question",
"type": "object",
"properties": {
"noOfCorrectAnswers": {
"format": "int32",
"description": "number of sessions which has this option/blank answered correctly",
"type": "integer"
},
"noOfIncorrectAnswers": {
"format": "int32",
"description": "number of sessions which has this option/blank answered wrongly",
"type": "integer"
},
"correctionRate": {
"format": "float",
"description": "percentage of sessions who has this option/blank answered correctly",
"type": "number",
"readOnly": true
},
"ptBiserial": {
"format": "double",
"description": "Point-biserial correlation coefficient",
"type": "number"
},
"order": {
"format": "int32",
"description": "blank option order",
"type": "integer"
},
"text": {
"description": "option text if any",
"type": "string"
}
}
}
},
"unmarkedQuestions": {
"format": "int32",
"description": "number of questions which have not been marked. Used for Essay Question",
"type": "integer"
}
}
}
}
}
}{
"averageScore": 0.0,
"medianScore": 0.0,
"standardDev": 0.0,
"kR20": 0.0,
"minScore": 0.0,
"maxScore": 0.0,
"questions": [
{
"id": "string",
"text": "string",
"type": "string",
"difficultyLevel": {},
"averageScore": 0.0,
"standardDev": 0.0,
"medianScore": 0.0,
"percentile25": 0.0,
"percentile75": 0.0,
"noOfCorrectAnswers": 0,
"noOfIncorrectAnswers": 0,
"ptBiserial": 0.0,
"correctionRate": 0.0,
"choiceOptions": [
{
"text": "string",
"noOfStudents": 0,
"selectionRate": 0.0,
"averageExamScore": 0.0,
"isCorrect": true,
"order": 0
}
],
"options": [
{
"noOfCorrectAnswers": 0,
"noOfIncorrectAnswers": 0,
"correctionRate": 0.0,
"ptBiserial": 0.0,
"order": 0,
"text": "string"
}
],
"unmarkedQuestions": 0
}
]
}{
"description": "Overall Analysis for normal assessment",
"type": "object",
"properties": {
"averageScore": {
"format": "double",
"description": "average value on all scores in class",
"type": "number"
},
"medianScore": {
"format": "double",
"description": "median score on all scores in class",
"type": "number"
},
"standardDev": {
"format": "double",
"description": "standard deviation on all scores in class",
"type": "number"
},
"kR20": {
"format": "double",
"description": "The value range is from 0 to 1, where 0 is no reliability and 1 is perfect reliability. The closer the score is to 1, the more reliable the test. Just what constitites an “acceptable” KR-20 score depends on the type of test. In general, a score of above .5 is usually considered reasonable.\r\nThis statistics is valid when there is no partial correct answers in this test.",
"type": "number"
},
"minScore": {
"format": "double",
"description": "lowest value on all scores in class",
"type": "number"
},
"maxScore": {
"format": "double",
"description": "highest value on all scores in class",
"type": "number"
},
"questions": {
"description": "detailed question analysis",
"type": "array",
"items": {
"description": "analysis for a question",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "question id",
"type": "string"
},
"text": {
"description": "question text",
"type": "string"
},
"type": {
"description": "question type",
"type": "string"
},
"difficultyLevel": {
"description": "difficulty level of the question",
"allOf": [
{
"format": "int32",
"description": "Difficulty level of question",
"enum": [
0,
1,
2,
3
],
"type": "integer"
}
]
},
"averageScore": {
"format": "double",
"description": "average score obtained for this question",
"type": "number"
},
"standardDev": {
"format": "double",
"description": "standard deviation on all scores in this question",
"type": "number"
},
"medianScore": {
"format": "double",
"description": "median score obtained for this question",
"type": "number"
},
"percentile25": {
"format": "double",
"description": "the marks for the 25th percentile threshold obtained from the question",
"type": "number"
},
"percentile75": {
"format": "double",
"description": "the marks for the 75th percentile threshold obtained from the question",
"type": "number"
},
"noOfCorrectAnswers": {
"format": "int32",
"description": "number of sessions which has this question answered correctly (has score > 0)",
"type": "integer"
},
"noOfIncorrectAnswers": {
"format": "int32",
"description": "number of sessions which has skipped this question or answered this question wrongly (has score <=0)",
"type": "integer"
},
"ptBiserial": {
"format": "double",
"description": "Point-biserial correlation coefficient",
"type": "number"
},
"correctionRate": {
"format": "double",
"description": "percentage of sessions who has this question answered correctly",
"type": "number",
"readOnly": true
},
"choiceOptions": {
"description": "detailed analysis for options used for choice selection questions",
"type": "array",
"items": {
"description": "detailed analysis for question options used for choice selection questions",
"type": "object",
"properties": {
"text": {
"description": "option text if any",
"type": "string"
},
"noOfStudents": {
"format": "int32",
"description": "number of sessions which has this option selected",
"type": "integer"
},
"selectionRate": {
"format": "double",
"description": "percentage of session which has this option selected",
"type": "number"
},
"averageExamScore": {
"format": "double",
"description": "average score of sessions which has this option selected",
"type": "number"
},
"isCorrect": {
"description": "indicate whether this option is correct",
"type": "boolean"
},
"order": {
"format": "int32",
"description": "option order",
"type": "integer"
}
}
}
},
"options": {
"description": "detailed analysis for question options used for Fill-in-the-blank question and matching question",
"type": "array",
"items": {
"description": "detailed analysis for question options used for Fill-in-the-blank question and matching question",
"type": "object",
"properties": {
"noOfCorrectAnswers": {
"format": "int32",
"description": "number of sessions which has this option/blank answered correctly",
"type": "integer"
},
"noOfIncorrectAnswers": {
"format": "int32",
"description": "number of sessions which has this option/blank answered wrongly",
"type": "integer"
},
"correctionRate": {
"format": "float",
"description": "percentage of sessions who has this option/blank answered correctly",
"type": "number",
"readOnly": true
},
"ptBiserial": {
"format": "double",
"description": "Point-biserial correlation coefficient",
"type": "number"
},
"order": {
"format": "int32",
"description": "blank option order",
"type": "integer"
},
"text": {
"description": "option text if any",
"type": "string"
}
}
}
},
"unmarkedQuestions": {
"format": "int32",
"description": "number of questions which have not been marked. Used for Essay Question",
"type": "integer"
}
}
}
}
}
}400 Bad Request
Bad Request
Representations
{
"type": "string"
}string{
"type": "string"
}string{
"type": "string"
}403 Forbidden
Forbidden
Representations
{
"type": "string"
}string{
"type": "string"
}string{
"type": "string"
}404 Not Found
Not Found
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/{id}/question_analysis?SessionType={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["SessionType"] = "{string}";
var uri = "https://luminus.azure-api.net/assessment/{id}/question_analysis?" + 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/{id}/question_analysis");
builder.setParameter("SessionType", "{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
"SessionType": "{string}",
};
$.ajax({
url: "https://luminus.azure-api.net/assessment/{id}/question_analysis?" + $.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/{id}/question_analysis";
NSArray* array = @[
// Request parameters
@"entities=true",
@"SessionType={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/{id}/question_analysis');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'SessionType' => '{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
'SessionType': '{string}',
})
try:
conn = httplib.HTTPSConnection('luminus.azure-api.net')
conn.request("GET", "/assessment/{id}/question_analysis?%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
'SessionType': '{string}',
})
try:
conn = http.client.HTTPSConnection('luminus.azure-api.net')
conn.request("GET", "/assessment/{id}/question_analysis?%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/{id}/question_analysis')
query = URI.encode_www_form({
# Request parameters
'SessionType' => '{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