Evaluation API
API change historyList of APIs related to Evaluation
Get evaluation sessions by evaluation ID
Get evaluation sessions by evaluation ID for all evaluation methods
Try itRequest
Request URL
Request parameters
-
string
Format - uuid. Evaluation Id
-
(optional)string
-
(optional)integer
Format - int32.
-
(optional)integer
Format - int32.
-
(optional)string
-
(optional)string
Accepted populate entities: Evaluator, Evaluatee
Request headers
Request body
Responses
200 OK
Returns list of evaluation sessions
Representations
{
"type": "array",
"items": {
"description": "Session",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "ID",
"type": "string"
},
"evaluationID": {
"format": "uuid",
"description": "Evaluation id",
"type": "string"
},
"evaluatorID": {
"format": "uuid",
"description": "who is able to evaluate -- student or group",
"type": "string"
},
"evaluateeID": {
"format": "uuid",
"description": "One who is evaluated -- student or group",
"type": "string"
},
"score": {
"format": "double",
"description": "MaximumMarks based on Evaluation Method",
"type": "number"
},
"createdDate": {
"format": "date-time",
"description": "The date this record is created",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "the ID of the user who created this record",
"type": "string"
},
"updatedDate": {
"format": "date-time",
"description": "The date this record is updated",
"type": "string"
},
"updatedBy": {
"format": "uuid",
"description": "the ID of the user who updated this record",
"type": "string"
},
"comment": {
"description": "The Comment",
"type": "string"
},
"evaluateeName": {
"description": "evaluatee username",
"type": "string"
},
"evaluateeMatricNo": {
"description": "evaluatee matric no",
"type": "string"
},
"evaluatorName": {
"description": "evaluator username",
"type": "string"
},
"evaluatorMatricNo": {
"description": "evaluator matric no",
"type": "string"
},
"responses": {
"description": "answers user made on question type evaluation method",
"type": "array",
"items": {
"description": "answers user made on an evaluation question",
"required": [
"questionID"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "response id",
"type": "string"
},
"createdDate": {
"format": "date-time",
"description": "when the answer is made last time",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "Id of the user who made the answer",
"type": "string"
},
"userID": {
"description": "login id of the user who made the answer",
"type": "string"
},
"userName": {
"description": "Name of the user who made the answer",
"type": "string"
},
"userMatrixNo": {
"description": "matrix number of the user who made the answer",
"type": "string"
},
"questionID": {
"format": "uuid",
"description": "question id",
"type": "string"
},
"options": {
"description": "Selected Response for list options:\r\n\r\nChoice Question - order of selected options, eg [3]\r\n\r\nOrdinal Question - new sorted order of the options, eg [2, 1, 3]\r\n\r\nConstant Sum Question - entered points for the ordered options, eg [20,30,50]\r\n\r\nScale Question = selected option for ordered statements. eg [2,1,3,5,5,6]",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"text": {
"description": "input text made for essay questions or \"Other\" option text in choice questions",
"type": "string"
},
"tof": {
"description": "answer for TOF question",
"type": "boolean"
},
"blank": {
"description": "answer for fill in the blank question",
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
[
{
"id": "string",
"evaluationID": "string",
"evaluatorID": "string",
"evaluateeID": "string",
"score": 0.0,
"createdDate": "string",
"creatorID": "string",
"updatedDate": "string",
"updatedBy": "string",
"comment": "string",
"evaluateeName": "string",
"evaluateeMatricNo": "string",
"evaluatorName": "string",
"evaluatorMatricNo": "string",
"responses": [
{
"id": "string",
"createdDate": "string",
"creatorID": "string",
"userID": "string",
"userName": "string",
"userMatrixNo": "string",
"questionID": "string",
"options": [
0
],
"text": "string",
"tof": true,
"blank": [
"string"
]
}
]
}
]
{
"type": "array",
"items": {
"description": "Session",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "ID",
"type": "string"
},
"evaluationID": {
"format": "uuid",
"description": "Evaluation id",
"type": "string"
},
"evaluatorID": {
"format": "uuid",
"description": "who is able to evaluate -- student or group",
"type": "string"
},
"evaluateeID": {
"format": "uuid",
"description": "One who is evaluated -- student or group",
"type": "string"
},
"score": {
"format": "double",
"description": "MaximumMarks based on Evaluation Method",
"type": "number"
},
"createdDate": {
"format": "date-time",
"description": "The date this record is created",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "the ID of the user who created this record",
"type": "string"
},
"updatedDate": {
"format": "date-time",
"description": "The date this record is updated",
"type": "string"
},
"updatedBy": {
"format": "uuid",
"description": "the ID of the user who updated this record",
"type": "string"
},
"comment": {
"description": "The Comment",
"type": "string"
},
"evaluateeName": {
"description": "evaluatee username",
"type": "string"
},
"evaluateeMatricNo": {
"description": "evaluatee matric no",
"type": "string"
},
"evaluatorName": {
"description": "evaluator username",
"type": "string"
},
"evaluatorMatricNo": {
"description": "evaluator matric no",
"type": "string"
},
"responses": {
"description": "answers user made on question type evaluation method",
"type": "array",
"items": {
"description": "answers user made on an evaluation question",
"required": [
"questionID"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "response id",
"type": "string"
},
"createdDate": {
"format": "date-time",
"description": "when the answer is made last time",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "Id of the user who made the answer",
"type": "string"
},
"userID": {
"description": "login id of the user who made the answer",
"type": "string"
},
"userName": {
"description": "Name of the user who made the answer",
"type": "string"
},
"userMatrixNo": {
"description": "matrix number of the user who made the answer",
"type": "string"
},
"questionID": {
"format": "uuid",
"description": "question id",
"type": "string"
},
"options": {
"description": "Selected Response for list options:\r\n\r\nChoice Question - order of selected options, eg [3]\r\n\r\nOrdinal Question - new sorted order of the options, eg [2, 1, 3]\r\n\r\nConstant Sum Question - entered points for the ordered options, eg [20,30,50]\r\n\r\nScale Question = selected option for ordered statements. eg [2,1,3,5,5,6]",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"text": {
"description": "input text made for essay questions or \"Other\" option text in choice questions",
"type": "string"
},
"tof": {
"description": "answer for TOF question",
"type": "boolean"
},
"blank": {
"description": "answer for fill in the blank question",
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
[
{
"id": "string",
"evaluationID": "string",
"evaluatorID": "string",
"evaluateeID": "string",
"score": 0.0,
"createdDate": "string",
"creatorID": "string",
"updatedDate": "string",
"updatedBy": "string",
"comment": "string",
"evaluateeName": "string",
"evaluateeMatricNo": "string",
"evaluatorName": "string",
"evaluatorMatricNo": "string",
"responses": [
{
"id": "string",
"createdDate": "string",
"creatorID": "string",
"userID": "string",
"userName": "string",
"userMatrixNo": "string",
"questionID": "string",
"options": [
0
],
"text": "string",
"tof": true,
"blank": [
"string"
]
}
]
}
]
{
"type": "array",
"items": {
"description": "Session",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "ID",
"type": "string"
},
"evaluationID": {
"format": "uuid",
"description": "Evaluation id",
"type": "string"
},
"evaluatorID": {
"format": "uuid",
"description": "who is able to evaluate -- student or group",
"type": "string"
},
"evaluateeID": {
"format": "uuid",
"description": "One who is evaluated -- student or group",
"type": "string"
},
"score": {
"format": "double",
"description": "MaximumMarks based on Evaluation Method",
"type": "number"
},
"createdDate": {
"format": "date-time",
"description": "The date this record is created",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "the ID of the user who created this record",
"type": "string"
},
"updatedDate": {
"format": "date-time",
"description": "The date this record is updated",
"type": "string"
},
"updatedBy": {
"format": "uuid",
"description": "the ID of the user who updated this record",
"type": "string"
},
"comment": {
"description": "The Comment",
"type": "string"
},
"evaluateeName": {
"description": "evaluatee username",
"type": "string"
},
"evaluateeMatricNo": {
"description": "evaluatee matric no",
"type": "string"
},
"evaluatorName": {
"description": "evaluator username",
"type": "string"
},
"evaluatorMatricNo": {
"description": "evaluator matric no",
"type": "string"
},
"responses": {
"description": "answers user made on question type evaluation method",
"type": "array",
"items": {
"description": "answers user made on an evaluation question",
"required": [
"questionID"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "response id",
"type": "string"
},
"createdDate": {
"format": "date-time",
"description": "when the answer is made last time",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "Id of the user who made the answer",
"type": "string"
},
"userID": {
"description": "login id of the user who made the answer",
"type": "string"
},
"userName": {
"description": "Name of the user who made the answer",
"type": "string"
},
"userMatrixNo": {
"description": "matrix number of the user who made the answer",
"type": "string"
},
"questionID": {
"format": "uuid",
"description": "question id",
"type": "string"
},
"options": {
"description": "Selected Response for list options:\r\n\r\nChoice Question - order of selected options, eg [3]\r\n\r\nOrdinal Question - new sorted order of the options, eg [2, 1, 3]\r\n\r\nConstant Sum Question - entered points for the ordered options, eg [20,30,50]\r\n\r\nScale Question = selected option for ordered statements. eg [2,1,3,5,5,6]",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"text": {
"description": "input text made for essay questions or \"Other\" option text in choice questions",
"type": "string"
},
"tof": {
"description": "answer for TOF question",
"type": "boolean"
},
"blank": {
"description": "answer for fill in the blank question",
"type": "array",
"items": {
"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/evaluation/EvaluationSession/EvaluationID/{ID}?sortby={string}&offset={integer}&limit={integer}&where={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["sortby"] = "{string}";
queryString["offset"] = "{integer}";
queryString["limit"] = "{integer}";
queryString["where"] = "{string}";
queryString["populate"] = "{string}";
var uri = "https://luminus.azure-api.net/evaluation/EvaluationSession/EvaluationID/{ID}?" + 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/evaluation/EvaluationSession/EvaluationID/{ID}");
builder.setParameter("sortby", "{string}");
builder.setParameter("offset", "{integer}");
builder.setParameter("limit", "{integer}");
builder.setParameter("where", "{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
"sortby": "{string}",
"offset": "{integer}",
"limit": "{integer}",
"where": "{string}",
"populate": "{string}",
};
$.ajax({
url: "https://luminus.azure-api.net/evaluation/EvaluationSession/EvaluationID/{ID}?" + $.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/evaluation/EvaluationSession/EvaluationID/{ID}";
NSArray* array = @[
// Request parameters
@"entities=true",
@"sortby={string}",
@"offset={integer}",
@"limit={integer}",
@"where={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/evaluation/EvaluationSession/EvaluationID/{ID}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'sortby' => '{string}',
'offset' => '{integer}',
'limit' => '{integer}',
'where' => '{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
'sortby': '{string}',
'offset': '{integer}',
'limit': '{integer}',
'where': '{string}',
'populate': '{string}',
})
try:
conn = httplib.HTTPSConnection('luminus.azure-api.net')
conn.request("GET", "/evaluation/EvaluationSession/EvaluationID/{ID}?%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
'sortby': '{string}',
'offset': '{integer}',
'limit': '{integer}',
'where': '{string}',
'populate': '{string}',
})
try:
conn = http.client.HTTPSConnection('luminus.azure-api.net')
conn.request("GET", "/evaluation/EvaluationSession/EvaluationID/{ID}?%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/evaluation/EvaluationSession/EvaluationID/{ID}')
query = URI.encode_www_form({
# Request parameters
'sortby' => '{string}',
'offset' => '{integer}',
'limit' => '{integer}',
'where' => '{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