Gradebook API
API change historyList of APIs related to Gradebook
Search graded items
Search for the list of graded items for the module.
If filter is provided, it will search based on that.
Try itRequest
Request URL
Request parameters
-
string
Format - uuid. Parent resource of Graded Item. i.e. Module ID
-
(optional)string
The text used for search
-
(optional)string
-
(optional)integer
Format - int32.
-
(optional)integer
Format - int32.
-
(optional)string
-
(optional)string
Accepted populate entities: creator, lastUpdatedUser
Request headers
Request body
Responses
200 OK
Returns a list of graded items
Representations
{
"type": "array",
"items": {
"required": [
"access"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"access": {
"allOf": [
{
"description": "flags to define access rights",
"type": "object",
"properties": {
"access_Full": {
"description": "all accesses on the resource and its contents",
"type": "boolean"
},
"access_Read": {
"description": "read-only access on the contents",
"type": "boolean"
},
"access_Create": {
"description": "create access on the contents",
"type": "boolean"
},
"access_Update": {
"description": "update access on the contents",
"type": "boolean"
},
"access_Delete": {
"description": "delete access on the contents",
"type": "boolean"
},
"access_Settings_Read": {
"description": "read-only access on the resource setting",
"type": "boolean"
},
"access_Settings_Update": {
"description": "update access on the resource setting",
"type": "boolean"
}
}
}
]
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"creatorID": {
"format": "uuid",
"type": "string"
},
"creatorName": {
"type": "string"
},
"creatorUserID": {
"type": "string"
},
"creatorEmail": {
"type": "string"
},
"readonlyAccess": {
"type": "boolean"
},
"lastUpdatedDate": {
"format": "date-time",
"type": "string"
},
"lastUpdatedBy": {
"format": "uuid",
"type": "string"
},
"lastUpdatedByName": {
"type": "string"
},
"lastUpdatedByUserID": {
"type": "string"
},
"lastUpdatedByEmail": {
"type": "string"
},
"startDate": {
"format": "date-time",
"type": "string"
},
"endDate": {
"format": "date-time",
"type": "string"
},
"publish": {
"type": "boolean",
"readOnly": true
},
"parentID": {
"format": "uuid",
"type": "string"
},
"rootID": {
"format": "uuid",
"type": "string"
},
"itemDesc": {
"type": "string"
},
"weightage": {
"format": "float",
"type": "number"
},
"maxMark": {
"format": "float",
"type": "number"
},
"importResource": {
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"toolType": {
"type": "string"
},
"toolTypeName": {
"type": "string",
"readOnly": true
},
"importType": {
"type": "string"
},
"importTypeName": {
"type": "string",
"readOnly": true
},
"showMark": {
"type": "boolean"
},
"showRemark": {
"type": "boolean"
},
"showGrade": {
"type": "boolean"
},
"showRubrics": {
"type": "boolean"
},
"showHighLow": {
"type": "boolean"
},
"showPercentile": {
"type": "boolean"
},
"showAverageMedian": {
"type": "boolean"
},
"scoreByMarks": {
"type": "boolean"
},
"gradingSchema": {
"type": "array",
"items": {
"required": [
"letterGrade",
"maxMark"
],
"type": "object",
"properties": {
"letterGrade": {
"type": "string"
},
"maxMark": {
"format": "float",
"type": "number"
}
}
}
},
"studentDisplayType": {
"type": "string"
},
"rubricID": {
"format": "uuid",
"type": "string"
}
}
}
}
[
{
"id": "string",
"name": "string",
"access": {
"access_Full": true,
"access_Read": true,
"access_Create": true,
"access_Update": true,
"access_Delete": true,
"access_Settings_Read": true,
"access_Settings_Update": true
},
"createdDate": "string",
"creatorID": "string",
"creatorName": "string",
"creatorUserID": "string",
"creatorEmail": "string",
"readonlyAccess": true,
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedByName": "string",
"lastUpdatedByUserID": "string",
"lastUpdatedByEmail": "string",
"startDate": "string",
"endDate": "string",
"publish": true,
"parentID": "string",
"rootID": "string",
"itemDesc": "string",
"weightage": 0.0,
"maxMark": 0.0,
"importResource": [
"string"
],
"toolType": "string",
"toolTypeName": "string",
"importType": "string",
"importTypeName": "string",
"showMark": true,
"showRemark": true,
"showGrade": true,
"showRubrics": true,
"showHighLow": true,
"showPercentile": true,
"showAverageMedian": true,
"scoreByMarks": true,
"gradingSchema": [
{
"letterGrade": "string",
"maxMark": 0.0
}
],
"studentDisplayType": "string",
"rubricID": "string"
}
]
{
"type": "array",
"items": {
"required": [
"access"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"access": {
"allOf": [
{
"description": "flags to define access rights",
"type": "object",
"properties": {
"access_Full": {
"description": "all accesses on the resource and its contents",
"type": "boolean"
},
"access_Read": {
"description": "read-only access on the contents",
"type": "boolean"
},
"access_Create": {
"description": "create access on the contents",
"type": "boolean"
},
"access_Update": {
"description": "update access on the contents",
"type": "boolean"
},
"access_Delete": {
"description": "delete access on the contents",
"type": "boolean"
},
"access_Settings_Read": {
"description": "read-only access on the resource setting",
"type": "boolean"
},
"access_Settings_Update": {
"description": "update access on the resource setting",
"type": "boolean"
}
}
}
]
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"creatorID": {
"format": "uuid",
"type": "string"
},
"creatorName": {
"type": "string"
},
"creatorUserID": {
"type": "string"
},
"creatorEmail": {
"type": "string"
},
"readonlyAccess": {
"type": "boolean"
},
"lastUpdatedDate": {
"format": "date-time",
"type": "string"
},
"lastUpdatedBy": {
"format": "uuid",
"type": "string"
},
"lastUpdatedByName": {
"type": "string"
},
"lastUpdatedByUserID": {
"type": "string"
},
"lastUpdatedByEmail": {
"type": "string"
},
"startDate": {
"format": "date-time",
"type": "string"
},
"endDate": {
"format": "date-time",
"type": "string"
},
"publish": {
"type": "boolean",
"readOnly": true
},
"parentID": {
"format": "uuid",
"type": "string"
},
"rootID": {
"format": "uuid",
"type": "string"
},
"itemDesc": {
"type": "string"
},
"weightage": {
"format": "float",
"type": "number"
},
"maxMark": {
"format": "float",
"type": "number"
},
"importResource": {
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"toolType": {
"type": "string"
},
"toolTypeName": {
"type": "string",
"readOnly": true
},
"importType": {
"type": "string"
},
"importTypeName": {
"type": "string",
"readOnly": true
},
"showMark": {
"type": "boolean"
},
"showRemark": {
"type": "boolean"
},
"showGrade": {
"type": "boolean"
},
"showRubrics": {
"type": "boolean"
},
"showHighLow": {
"type": "boolean"
},
"showPercentile": {
"type": "boolean"
},
"showAverageMedian": {
"type": "boolean"
},
"scoreByMarks": {
"type": "boolean"
},
"gradingSchema": {
"type": "array",
"items": {
"required": [
"letterGrade",
"maxMark"
],
"type": "object",
"properties": {
"letterGrade": {
"type": "string"
},
"maxMark": {
"format": "float",
"type": "number"
}
}
}
},
"studentDisplayType": {
"type": "string"
},
"rubricID": {
"format": "uuid",
"type": "string"
}
}
}
}
[
{
"id": "string",
"name": "string",
"access": {
"access_Full": true,
"access_Read": true,
"access_Create": true,
"access_Update": true,
"access_Delete": true,
"access_Settings_Read": true,
"access_Settings_Update": true
},
"createdDate": "string",
"creatorID": "string",
"creatorName": "string",
"creatorUserID": "string",
"creatorEmail": "string",
"readonlyAccess": true,
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedByName": "string",
"lastUpdatedByUserID": "string",
"lastUpdatedByEmail": "string",
"startDate": "string",
"endDate": "string",
"publish": true,
"parentID": "string",
"rootID": "string",
"itemDesc": "string",
"weightage": 0.0,
"maxMark": 0.0,
"importResource": [
"string"
],
"toolType": "string",
"toolTypeName": "string",
"importType": "string",
"importTypeName": "string",
"showMark": true,
"showRemark": true,
"showGrade": true,
"showRubrics": true,
"showHighLow": true,
"showPercentile": true,
"showAverageMedian": true,
"scoreByMarks": true,
"gradingSchema": [
{
"letterGrade": "string",
"maxMark": 0.0
}
],
"studentDisplayType": "string",
"rubricID": "string"
}
]
{
"type": "array",
"items": {
"required": [
"access"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"access": {
"allOf": [
{
"description": "flags to define access rights",
"type": "object",
"properties": {
"access_Full": {
"description": "all accesses on the resource and its contents",
"type": "boolean"
},
"access_Read": {
"description": "read-only access on the contents",
"type": "boolean"
},
"access_Create": {
"description": "create access on the contents",
"type": "boolean"
},
"access_Update": {
"description": "update access on the contents",
"type": "boolean"
},
"access_Delete": {
"description": "delete access on the contents",
"type": "boolean"
},
"access_Settings_Read": {
"description": "read-only access on the resource setting",
"type": "boolean"
},
"access_Settings_Update": {
"description": "update access on the resource setting",
"type": "boolean"
}
}
}
]
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"creatorID": {
"format": "uuid",
"type": "string"
},
"creatorName": {
"type": "string"
},
"creatorUserID": {
"type": "string"
},
"creatorEmail": {
"type": "string"
},
"readonlyAccess": {
"type": "boolean"
},
"lastUpdatedDate": {
"format": "date-time",
"type": "string"
},
"lastUpdatedBy": {
"format": "uuid",
"type": "string"
},
"lastUpdatedByName": {
"type": "string"
},
"lastUpdatedByUserID": {
"type": "string"
},
"lastUpdatedByEmail": {
"type": "string"
},
"startDate": {
"format": "date-time",
"type": "string"
},
"endDate": {
"format": "date-time",
"type": "string"
},
"publish": {
"type": "boolean",
"readOnly": true
},
"parentID": {
"format": "uuid",
"type": "string"
},
"rootID": {
"format": "uuid",
"type": "string"
},
"itemDesc": {
"type": "string"
},
"weightage": {
"format": "float",
"type": "number"
},
"maxMark": {
"format": "float",
"type": "number"
},
"importResource": {
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"toolType": {
"type": "string"
},
"toolTypeName": {
"type": "string",
"readOnly": true
},
"importType": {
"type": "string"
},
"importTypeName": {
"type": "string",
"readOnly": true
},
"showMark": {
"type": "boolean"
},
"showRemark": {
"type": "boolean"
},
"showGrade": {
"type": "boolean"
},
"showRubrics": {
"type": "boolean"
},
"showHighLow": {
"type": "boolean"
},
"showPercentile": {
"type": "boolean"
},
"showAverageMedian": {
"type": "boolean"
},
"scoreByMarks": {
"type": "boolean"
},
"gradingSchema": {
"type": "array",
"items": {
"required": [
"letterGrade",
"maxMark"
],
"type": "object",
"properties": {
"letterGrade": {
"type": "string"
},
"maxMark": {
"format": "float",
"type": "number"
}
}
}
},
"studentDisplayType": {
"type": "string"
},
"rubricID": {
"format": "uuid",
"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/gradebook/Module/{ParentID}/Search?searchtext={string}&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["searchtext"] = "{string}";
queryString["sortby"] = "{string}";
queryString["offset"] = "{integer}";
queryString["limit"] = "{integer}";
queryString["where"] = "{string}";
queryString["populate"] = "{string}";
var uri = "https://luminus.azure-api.net/gradebook/Module/{ParentID}/Search?" + 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/Module/{ParentID}/Search");
builder.setParameter("searchtext", "{string}");
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
"searchtext": "{string}",
"sortby": "{string}",
"offset": "{integer}",
"limit": "{integer}",
"where": "{string}",
"populate": "{string}",
};
$.ajax({
url: "https://luminus.azure-api.net/gradebook/Module/{ParentID}/Search?" + $.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/Module/{ParentID}/Search";
NSArray* array = @[
// Request parameters
@"entities=true",
@"searchtext={string}",
@"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/Module/{ParentID}/Search');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'searchtext' => '{string}',
'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
'searchtext': '{string}',
'sortby': '{string}',
'offset': '{integer}',
'limit': '{integer}',
'where': '{string}',
'populate': '{string}',
})
try:
conn = httplib.HTTPSConnection('luminus.azure-api.net')
conn.request("GET", "/gradebook/Module/{ParentID}/Search?%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
'searchtext': '{string}',
'sortby': '{string}',
'offset': '{integer}',
'limit': '{integer}',
'where': '{string}',
'populate': '{string}',
})
try:
conn = http.client.HTTPSConnection('luminus.azure-api.net')
conn.request("GET", "/gradebook/Module/{ParentID}/Search?%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/Module/{ParentID}/Search')
query = URI.encode_www_form({
# Request parameters
'searchtext' => '{string}',
'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