Gradebook API
API change historyList of APIs related to Gradebook
Get graded item's audit trail
Get the audit trail for the graded item.
Students cannot see the audit trail.
Try itRequest
Request URL
Request parameters
-
string
Format - uuid. Grade Item ID
-
(optional)string
-
(optional)integer
Format - int32.
-
(optional)integer
Format - int32.
-
(optional)string
-
(optional)string
Accepted populate entities: creator, student
Request headers
Request body
Responses
200 OK
Returns list of [API_Gradebook.API.ScoreLog]
Representations
{
"type": "array",
"items": {
"description": "Logs for the Score Log content",
"type": "object",
"properties": {
"targetID": {
"format": "uuid",
"description": "ID of the Score",
"type": "string"
},
"logDate": {
"format": "date-time",
"description": "Date of the action",
"type": "string"
},
"ip": {
"description": "IP address of the user who enter the score",
"type": "string"
},
"userGuid": {
"format": "uuid",
"description": "ID of the person who enter the score",
"type": "string"
},
"studentUserGuid": {
"format": "uuid",
"description": "ID of the Student for the Score",
"type": "string"
},
"mark": {
"format": "float",
"description": "Student's Mark entered for the Grade Item",
"type": "number"
},
"moderation": {
"format": "float",
"description": "Student's Moderation entered for the Grade Item",
"type": "number"
},
"remark": {
"description": "Student's Remarks entered for the grade item",
"type": "string"
},
"action": {
"description": "Action. I = Insert; U = Update; D = Delete;",
"type": "string"
},
"actionName": {
"description": "Name of the Action",
"type": "string",
"readOnly": true
},
"scoreBy": {
"description": "Whether the grade item is score by marks or rubrics",
"type": "string"
},
"description": {
"description": "Description whereby the score is being entered",
"type": "string"
},
"creatorUserID": {
"description": "User ID of the Creator",
"type": "string"
},
"creatorName": {
"description": "Name of the Creator",
"type": "string"
},
"creatorEmail": {
"description": "Email of the Creator",
"type": "string"
},
"studentUserID": {
"description": "User ID of the Student",
"type": "string"
},
"studentName": {
"description": "Name of the Student",
"type": "string"
},
"studentEmail": {
"description": "Email of the Student",
"type": "string"
},
"studentMatricNo": {
"description": "Student number/matriculation number of the student",
"type": "string"
}
}
}
}
[
{
"targetID": "string",
"logDate": "string",
"ip": "string",
"userGuid": "string",
"studentUserGuid": "string",
"mark": 0.0,
"moderation": 0.0,
"remark": "string",
"action": "string",
"actionName": "string",
"scoreBy": "string",
"description": "string",
"creatorUserID": "string",
"creatorName": "string",
"creatorEmail": "string",
"studentUserID": "string",
"studentName": "string",
"studentEmail": "string",
"studentMatricNo": "string"
}
]
{
"type": "array",
"items": {
"description": "Logs for the Score Log content",
"type": "object",
"properties": {
"targetID": {
"format": "uuid",
"description": "ID of the Score",
"type": "string"
},
"logDate": {
"format": "date-time",
"description": "Date of the action",
"type": "string"
},
"ip": {
"description": "IP address of the user who enter the score",
"type": "string"
},
"userGuid": {
"format": "uuid",
"description": "ID of the person who enter the score",
"type": "string"
},
"studentUserGuid": {
"format": "uuid",
"description": "ID of the Student for the Score",
"type": "string"
},
"mark": {
"format": "float",
"description": "Student's Mark entered for the Grade Item",
"type": "number"
},
"moderation": {
"format": "float",
"description": "Student's Moderation entered for the Grade Item",
"type": "number"
},
"remark": {
"description": "Student's Remarks entered for the grade item",
"type": "string"
},
"action": {
"description": "Action. I = Insert; U = Update; D = Delete;",
"type": "string"
},
"actionName": {
"description": "Name of the Action",
"type": "string",
"readOnly": true
},
"scoreBy": {
"description": "Whether the grade item is score by marks or rubrics",
"type": "string"
},
"description": {
"description": "Description whereby the score is being entered",
"type": "string"
},
"creatorUserID": {
"description": "User ID of the Creator",
"type": "string"
},
"creatorName": {
"description": "Name of the Creator",
"type": "string"
},
"creatorEmail": {
"description": "Email of the Creator",
"type": "string"
},
"studentUserID": {
"description": "User ID of the Student",
"type": "string"
},
"studentName": {
"description": "Name of the Student",
"type": "string"
},
"studentEmail": {
"description": "Email of the Student",
"type": "string"
},
"studentMatricNo": {
"description": "Student number/matriculation number of the student",
"type": "string"
}
}
}
}
[
{
"targetID": "string",
"logDate": "string",
"ip": "string",
"userGuid": "string",
"studentUserGuid": "string",
"mark": 0.0,
"moderation": 0.0,
"remark": "string",
"action": "string",
"actionName": "string",
"scoreBy": "string",
"description": "string",
"creatorUserID": "string",
"creatorName": "string",
"creatorEmail": "string",
"studentUserID": "string",
"studentName": "string",
"studentEmail": "string",
"studentMatricNo": "string"
}
]
{
"type": "array",
"items": {
"description": "Logs for the Score Log content",
"type": "object",
"properties": {
"targetID": {
"format": "uuid",
"description": "ID of the Score",
"type": "string"
},
"logDate": {
"format": "date-time",
"description": "Date of the action",
"type": "string"
},
"ip": {
"description": "IP address of the user who enter the score",
"type": "string"
},
"userGuid": {
"format": "uuid",
"description": "ID of the person who enter the score",
"type": "string"
},
"studentUserGuid": {
"format": "uuid",
"description": "ID of the Student for the Score",
"type": "string"
},
"mark": {
"format": "float",
"description": "Student's Mark entered for the Grade Item",
"type": "number"
},
"moderation": {
"format": "float",
"description": "Student's Moderation entered for the Grade Item",
"type": "number"
},
"remark": {
"description": "Student's Remarks entered for the grade item",
"type": "string"
},
"action": {
"description": "Action. I = Insert; U = Update; D = Delete;",
"type": "string"
},
"actionName": {
"description": "Name of the Action",
"type": "string",
"readOnly": true
},
"scoreBy": {
"description": "Whether the grade item is score by marks or rubrics",
"type": "string"
},
"description": {
"description": "Description whereby the score is being entered",
"type": "string"
},
"creatorUserID": {
"description": "User ID of the Creator",
"type": "string"
},
"creatorName": {
"description": "Name of the Creator",
"type": "string"
},
"creatorEmail": {
"description": "Email of the Creator",
"type": "string"
},
"studentUserID": {
"description": "User ID of the Student",
"type": "string"
},
"studentName": {
"description": "Name of the Student",
"type": "string"
},
"studentEmail": {
"description": "Email of the Student",
"type": "string"
},
"studentMatricNo": {
"description": "Student number/matriculation number of the student",
"type": "string"
}
}
}
}
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/gradebook/{ID}/Score/Log?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/gradebook/{ID}/Score/Log?" + 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/gradebook/{ID}/Score/Log");
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/gradebook/{ID}/Score/Log?" + $.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/gradebook/{ID}/Score/Log";
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/gradebook/{ID}/Score/Log');
$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", "/gradebook/{ID}/Score/Log?%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", "/gradebook/{ID}/Score/Log?%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/{ID}/Score/Log')
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