Gradebook API
API change historyList of APIs related to Gradebook
Update group's scores
To update the scores for the students in a group for the graded item.
NOTE:
Only managers (except read only managers) can update the score entries. However, non-NUS users, regardless of the access, are not permitted.
Partial update not applicable for rubrics markings.
This is not for updating scores of individual student.
This will add the audit trail for the grade item score.
If the score is being changed, verification will be reset. Affected students' completed task will be deleted.
Request
Request URL
Request parameters
-
(optional)boolean
Whether to view/mark the students anonymously. If anonymous, will only see the student number instead of the student name. Default is false.
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
The information of the Grade Item Score to be edited
{
"groupID": "string",
"userMarkDetail": [
{
"criteriaID": "string",
"score": 0.0,
"comment": "string"
}
],
"targetID": "string",
"mark": 0.0,
"moderation": 0.0,
"remark": "2112B691-EBDF-4537-81D0-00005DDE2047a"
}
{
"description": "Input class for updating Grade Item Score for a group",
"required": [
"groupID",
"targetID"
],
"type": "object",
"properties": {
"groupID": {
"format": "uuid",
"description": "ID of the group for the Mark/Comment. Applicable if mark by group.",
"type": "string"
},
"userMarkDetail": {
"description": "List of marking/comments for the rubric of the receiver. Applicable if score by rubric.\r\nNo partial update, so need to include the full set.",
"type": "array",
"items": {
"required": [
"criteriaID",
"score"
],
"type": "object",
"properties": {
"criteriaID": {
"format": "uuid",
"type": "string"
},
"score": {
"format": "double",
"type": "number"
},
"comment": {
"maxLength": 500,
"minLength": 0,
"type": "string"
}
}
}
},
"targetID": {
"format": "uuid",
"type": "string"
},
"mark": {
"format": "float",
"type": "number"
},
"moderation": {
"format": "float",
"type": "number"
},
"remark": {
"default": "2112B691-EBDF-4537-81D0-00005DDE2047a",
"type": "string"
}
}
}
{
"groupID": "string",
"userMarkDetail": [
{
"criteriaID": "string",
"score": 0.0,
"comment": "string"
}
],
"targetID": "string",
"mark": 0.0,
"moderation": 0.0,
"remark": "2112B691-EBDF-4537-81D0-00005DDE2047a"
}
{
"description": "Input class for updating Grade Item Score for a group",
"required": [
"groupID",
"targetID"
],
"type": "object",
"properties": {
"groupID": {
"format": "uuid",
"description": "ID of the group for the Mark/Comment. Applicable if mark by group.",
"type": "string"
},
"userMarkDetail": {
"description": "List of marking/comments for the rubric of the receiver. Applicable if score by rubric.\r\nNo partial update, so need to include the full set.",
"type": "array",
"items": {
"required": [
"criteriaID",
"score"
],
"type": "object",
"properties": {
"criteriaID": {
"format": "uuid",
"type": "string"
},
"score": {
"format": "double",
"type": "number"
},
"comment": {
"maxLength": 500,
"minLength": 0,
"type": "string"
}
}
}
},
"targetID": {
"format": "uuid",
"type": "string"
},
"mark": {
"format": "float",
"type": "number"
},
"moderation": {
"format": "float",
"type": "number"
},
"remark": {
"default": "2112B691-EBDF-4537-81D0-00005DDE2047a",
"type": "string"
}
}
}
{
"groupID": "string",
"userMarkDetail": [
{
"criteriaID": "string",
"score": 0.0,
"comment": "string"
}
],
"targetID": "string",
"mark": 0.0,
"moderation": 0.0,
"remark": "2112B691-EBDF-4537-81D0-00005DDE2047a"
}
{
"description": "Input class for updating Grade Item Score for a group",
"required": [
"groupID",
"targetID"
],
"type": "object",
"properties": {
"groupID": {
"format": "uuid",
"description": "ID of the group for the Mark/Comment. Applicable if mark by group.",
"type": "string"
},
"userMarkDetail": {
"description": "List of marking/comments for the rubric of the receiver. Applicable if score by rubric.\r\nNo partial update, so need to include the full set.",
"type": "array",
"items": {
"required": [
"criteriaID",
"score"
],
"type": "object",
"properties": {
"criteriaID": {
"format": "uuid",
"type": "string"
},
"score": {
"format": "double",
"type": "number"
},
"comment": {
"maxLength": 500,
"minLength": 0,
"type": "string"
}
}
}
},
"targetID": {
"format": "uuid",
"type": "string"
},
"mark": {
"format": "float",
"type": "number"
},
"moderation": {
"format": "float",
"type": "number"
},
"remark": {
"default": "2112B691-EBDF-4537-81D0-00005DDE2047a",
"type": "string"
}
}
}
{
"groupID": "string",
"userMarkDetail": [
{
"criteriaID": "string",
"score": 0.0,
"comment": "string"
}
],
"targetID": "string",
"mark": 0.0,
"moderation": 0.0,
"remark": "2112B691-EBDF-4537-81D0-00005DDE2047a"
}
{
"description": "Input class for updating Grade Item Score for a group",
"required": [
"groupID",
"targetID"
],
"type": "object",
"properties": {
"groupID": {
"format": "uuid",
"description": "ID of the group for the Mark/Comment. Applicable if mark by group.",
"type": "string"
},
"userMarkDetail": {
"description": "List of marking/comments for the rubric of the receiver. Applicable if score by rubric.\r\nNo partial update, so need to include the full set.",
"type": "array",
"items": {
"required": [
"criteriaID",
"score"
],
"type": "object",
"properties": {
"criteriaID": {
"format": "uuid",
"type": "string"
},
"score": {
"format": "double",
"type": "number"
},
"comment": {
"maxLength": 500,
"minLength": 0,
"type": "string"
}
}
}
},
"targetID": {
"format": "uuid",
"type": "string"
},
"mark": {
"format": "float",
"type": "number"
},
"moderation": {
"format": "float",
"type": "number"
},
"remark": {
"default": "2112B691-EBDF-4537-81D0-00005DDE2047a",
"type": "string"
}
}
}
Responses
200 OK
the records affected
Representations
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"
}
404 Not Found
Record 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 PUT "https://luminus.azure-api.net/gradebook/Score?AnonymousMarking={boolean}"
-H "Content-Type: application/json-patch+json"
-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["AnonymousMarking"] = "{boolean}";
var uri = "https://luminus.azure-api.net/gradebook/Score?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PutAsync(uri, content);
}
}
}
}
// // 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/gradebook/Score");
builder.setParameter("AnonymousMarking", "{boolean}");
URI uri = builder.build();
HttpPut request = new HttpPut(uri);
request.setHeader("Content-Type", "application/json-patch+json");
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
"AnonymousMarking": "{boolean}",
};
$.ajax({
url: "https://luminus.azure-api.net/gradebook/Score?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json-patch+json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "PUT",
// 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/gradebook/Score";
NSArray* array = @[
// Request parameters
@"entities=true",
@"AnonymousMarking={boolean}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"PUT"];
// Request headers
[_request setValue:@"application/json-patch+json" forHTTPHeaderField:@"Content-Type"];
[_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/gradebook/Score');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json-patch+json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'AnonymousMarking' => '{boolean}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_PUT);
// 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
'Content-Type': 'application/json-patch+json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'AnonymousMarking': '{boolean}',
})
try:
conn = httplib.HTTPSConnection('luminus.azure-api.net')
conn.request("PUT", "/gradebook/Score?%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
'Content-Type': 'application/json-patch+json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'AnonymousMarking': '{boolean}',
})
try:
conn = http.client.HTTPSConnection('luminus.azure-api.net')
conn.request("PUT", "/gradebook/Score?%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/gradebook/Score')
query = URI.encode_www_form({
# Request parameters
'AnonymousMarking' => '{boolean}'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
request = Net::HTTP::Put.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json-patch+json'
# 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