Gradebook API

API change history

List of APIs related to Gradebook

Get graded item score

Get score of the graded item.

  1. Students can only see their own score.

  2. Students cannot see the audit trail.

Try it

Request

Request URL

Request parameters

  • string

    Format - uuid. Grade Item Score ID

  • (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.

  • (optional)
    boolean

    Whether to allow zero in the computation of the highest and lowest marks, and the 25/75 percentile for the grade item. Applicable for "analytics" populate.

  • (optional)
    string

    Accepted populate entities: creator, lastUpdatedUser, student, gradeItem, rubric, userMarkDetail, analytics, auditTrail

    For the "analytics" populate, it will populate the fields:- highest mark, lowest mark, average mark, median mark, 25th percentile mark and 75th percentile mark.

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Returns [API_Gradebook.API.GradeItemScore]

Representations

{
  "description": "Grade Item Score",
  "type": "object",
  "properties": {
    "grade": {
      "description": "Grade for the student (computed based on the final mark and rubrics)",
      "type": "string"
    },
    "verifiedDate": {
      "format": "date-time",
      "description": "Date which the student verified the inputs for the Grade Item",
      "type": "string"
    },
    "studentUserGuid": {
      "format": "uuid",
      "description": "ID of the student with Mark/Comment",
      "type": "string"
    },
    "studentName": {
      "description": "The name of the student for the grade item with inputs",
      "type": "string"
    },
    "studentUserID": {
      "description": "The user ID of the student for the grade item with inputs",
      "type": "string"
    },
    "studentEmail": {
      "description": "The email address of the student for the grade item with inputs",
      "type": "string"
    },
    "studentMatricNo": {
      "description": "The student number/matriculation number of the student for the grade item with inputs",
      "type": "string"
    },
    "groupID": {
      "format": "uuid",
      "description": "ID of the group with Mark/Comment",
      "type": "string"
    },
    "userMarkDetail": {
      "description": "User's marks and comments for each of the criteria in Rubrics",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "receiverID": {
            "format": "uuid",
            "type": "string"
          },
          "targetID": {
            "format": "uuid",
            "type": "string"
          },
          "criteriaID": {
            "format": "uuid",
            "type": "string"
          },
          "performanceID": {
            "format": "uuid",
            "type": "string"
          },
          "rubricDetailID": {
            "format": "uuid",
            "type": "string"
          },
          "score": {
            "format": "double",
            "type": "number"
          },
          "comment": {
            "type": "string"
          },
          "createdBy": {
            "format": "uuid",
            "type": "string"
          },
          "createdDate": {
            "format": "date-time",
            "type": "string"
          },
          "updatedBy": {
            "format": "uuid",
            "type": "string"
          },
          "updatedDate": {
            "format": "date-time",
            "type": "string"
          }
        }
      }
    },
    "id": {
      "format": "uuid",
      "description": "ID of the Mark/Comment",
      "type": "string"
    },
    "targetID": {
      "format": "uuid",
      "description": "Target ID which this comment/mark for",
      "type": "string"
    },
    "resourceID": {
      "format": "uuid",
      "description": "the folder ID  or tool ID which contains this comment/mark",
      "type": "string"
    },
    "publish": {
      "description": "the publish flag which determine whether the record is published to students.",
      "type": "boolean"
    },
    "mark": {
      "format": "float",
      "description": "Marks entered for the student",
      "type": "number"
    },
    "moderation": {
      "format": "float",
      "description": "Moderation entered for the student",
      "type": "number"
    },
    "finalMark": {
      "format": "float",
      "description": "Final Mark for the student (computed column)",
      "type": "number"
    },
    "remark": {
      "description": "Remarks entered for the student",
      "type": "string"
    },
    "createdDate": {
      "format": "date-time",
      "description": "The date this grade item score is created",
      "type": "string"
    },
    "creatorID": {
      "format": "uuid",
      "description": "the ID of the user who created this grade item score",
      "type": "string"
    },
    "creatorName": {
      "description": "The name of the user who created the grade item score",
      "type": "string"
    },
    "creatorUserID": {
      "description": "The user ID of the user who created the grade item score",
      "type": "string"
    },
    "creatorEmail": {
      "description": "The email address of the user who created the grade item score",
      "type": "string"
    },
    "lastUpdatedDate": {
      "format": "date-time",
      "description": "the date this grade item score is last edited",
      "type": "string"
    },
    "lastUpdatedBy": {
      "format": "uuid",
      "description": "the ID of the user who edited this grade item score",
      "type": "string"
    },
    "lastUpdatedByName": {
      "description": "The name of the user who last updated the grade item score",
      "type": "string"
    },
    "lastUpdatedByUserID": {
      "description": "The user ID of the user who last updated the grade item score",
      "type": "string"
    },
    "lastUpdatedByEmail": {
      "description": "The email address of the user who last updated the grade item score",
      "type": "string"
    }
  }
}
{
  "grade": "string",
  "verifiedDate": "string",
  "studentUserGuid": "string",
  "studentName": "string",
  "studentUserID": "string",
  "studentEmail": "string",
  "studentMatricNo": "string",
  "groupID": "string",
  "userMarkDetail": [
    {
      "id": "string",
      "receiverID": "string",
      "targetID": "string",
      "criteriaID": "string",
      "performanceID": "string",
      "rubricDetailID": "string",
      "score": 0.0,
      "comment": "string",
      "createdBy": "string",
      "createdDate": "string",
      "updatedBy": "string",
      "updatedDate": "string"
    }
  ],
  "id": "string",
  "targetID": "string",
  "resourceID": "string",
  "publish": true,
  "mark": 0.0,
  "moderation": 0.0,
  "finalMark": 0.0,
  "remark": "string",
  "createdDate": "string",
  "creatorID": "string",
  "creatorName": "string",
  "creatorUserID": "string",
  "creatorEmail": "string",
  "lastUpdatedDate": "string",
  "lastUpdatedBy": "string",
  "lastUpdatedByName": "string",
  "lastUpdatedByUserID": "string",
  "lastUpdatedByEmail": "string"
}
{
  "description": "Grade Item Score",
  "type": "object",
  "properties": {
    "grade": {
      "description": "Grade for the student (computed based on the final mark and rubrics)",
      "type": "string"
    },
    "verifiedDate": {
      "format": "date-time",
      "description": "Date which the student verified the inputs for the Grade Item",
      "type": "string"
    },
    "studentUserGuid": {
      "format": "uuid",
      "description": "ID of the student with Mark/Comment",
      "type": "string"
    },
    "studentName": {
      "description": "The name of the student for the grade item with inputs",
      "type": "string"
    },
    "studentUserID": {
      "description": "The user ID of the student for the grade item with inputs",
      "type": "string"
    },
    "studentEmail": {
      "description": "The email address of the student for the grade item with inputs",
      "type": "string"
    },
    "studentMatricNo": {
      "description": "The student number/matriculation number of the student for the grade item with inputs",
      "type": "string"
    },
    "groupID": {
      "format": "uuid",
      "description": "ID of the group with Mark/Comment",
      "type": "string"
    },
    "userMarkDetail": {
      "description": "User's marks and comments for each of the criteria in Rubrics",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "receiverID": {
            "format": "uuid",
            "type": "string"
          },
          "targetID": {
            "format": "uuid",
            "type": "string"
          },
          "criteriaID": {
            "format": "uuid",
            "type": "string"
          },
          "performanceID": {
            "format": "uuid",
            "type": "string"
          },
          "rubricDetailID": {
            "format": "uuid",
            "type": "string"
          },
          "score": {
            "format": "double",
            "type": "number"
          },
          "comment": {
            "type": "string"
          },
          "createdBy": {
            "format": "uuid",
            "type": "string"
          },
          "createdDate": {
            "format": "date-time",
            "type": "string"
          },
          "updatedBy": {
            "format": "uuid",
            "type": "string"
          },
          "updatedDate": {
            "format": "date-time",
            "type": "string"
          }
        }
      }
    },
    "id": {
      "format": "uuid",
      "description": "ID of the Mark/Comment",
      "type": "string"
    },
    "targetID": {
      "format": "uuid",
      "description": "Target ID which this comment/mark for",
      "type": "string"
    },
    "resourceID": {
      "format": "uuid",
      "description": "the folder ID  or tool ID which contains this comment/mark",
      "type": "string"
    },
    "publish": {
      "description": "the publish flag which determine whether the record is published to students.",
      "type": "boolean"
    },
    "mark": {
      "format": "float",
      "description": "Marks entered for the student",
      "type": "number"
    },
    "moderation": {
      "format": "float",
      "description": "Moderation entered for the student",
      "type": "number"
    },
    "finalMark": {
      "format": "float",
      "description": "Final Mark for the student (computed column)",
      "type": "number"
    },
    "remark": {
      "description": "Remarks entered for the student",
      "type": "string"
    },
    "createdDate": {
      "format": "date-time",
      "description": "The date this grade item score is created",
      "type": "string"
    },
    "creatorID": {
      "format": "uuid",
      "description": "the ID of the user who created this grade item score",
      "type": "string"
    },
    "creatorName": {
      "description": "The name of the user who created the grade item score",
      "type": "string"
    },
    "creatorUserID": {
      "description": "The user ID of the user who created the grade item score",
      "type": "string"
    },
    "creatorEmail": {
      "description": "The email address of the user who created the grade item score",
      "type": "string"
    },
    "lastUpdatedDate": {
      "format": "date-time",
      "description": "the date this grade item score is last edited",
      "type": "string"
    },
    "lastUpdatedBy": {
      "format": "uuid",
      "description": "the ID of the user who edited this grade item score",
      "type": "string"
    },
    "lastUpdatedByName": {
      "description": "The name of the user who last updated the grade item score",
      "type": "string"
    },
    "lastUpdatedByUserID": {
      "description": "The user ID of the user who last updated the grade item score",
      "type": "string"
    },
    "lastUpdatedByEmail": {
      "description": "The email address of the user who last updated the grade item score",
      "type": "string"
    }
  }
}
{
  "grade": "string",
  "verifiedDate": "string",
  "studentUserGuid": "string",
  "studentName": "string",
  "studentUserID": "string",
  "studentEmail": "string",
  "studentMatricNo": "string",
  "groupID": "string",
  "userMarkDetail": [
    {
      "id": "string",
      "receiverID": "string",
      "targetID": "string",
      "criteriaID": "string",
      "performanceID": "string",
      "rubricDetailID": "string",
      "score": 0.0,
      "comment": "string",
      "createdBy": "string",
      "createdDate": "string",
      "updatedBy": "string",
      "updatedDate": "string"
    }
  ],
  "id": "string",
  "targetID": "string",
  "resourceID": "string",
  "publish": true,
  "mark": 0.0,
  "moderation": 0.0,
  "finalMark": 0.0,
  "remark": "string",
  "createdDate": "string",
  "creatorID": "string",
  "creatorName": "string",
  "creatorUserID": "string",
  "creatorEmail": "string",
  "lastUpdatedDate": "string",
  "lastUpdatedBy": "string",
  "lastUpdatedByName": "string",
  "lastUpdatedByUserID": "string",
  "lastUpdatedByEmail": "string"
}
{
  "description": "Grade Item Score",
  "type": "object",
  "properties": {
    "grade": {
      "description": "Grade for the student (computed based on the final mark and rubrics)",
      "type": "string"
    },
    "verifiedDate": {
      "format": "date-time",
      "description": "Date which the student verified the inputs for the Grade Item",
      "type": "string"
    },
    "studentUserGuid": {
      "format": "uuid",
      "description": "ID of the student with Mark/Comment",
      "type": "string"
    },
    "studentName": {
      "description": "The name of the student for the grade item with inputs",
      "type": "string"
    },
    "studentUserID": {
      "description": "The user ID of the student for the grade item with inputs",
      "type": "string"
    },
    "studentEmail": {
      "description": "The email address of the student for the grade item with inputs",
      "type": "string"
    },
    "studentMatricNo": {
      "description": "The student number/matriculation number of the student for the grade item with inputs",
      "type": "string"
    },
    "groupID": {
      "format": "uuid",
      "description": "ID of the group with Mark/Comment",
      "type": "string"
    },
    "userMarkDetail": {
      "description": "User's marks and comments for each of the criteria in Rubrics",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "receiverID": {
            "format": "uuid",
            "type": "string"
          },
          "targetID": {
            "format": "uuid",
            "type": "string"
          },
          "criteriaID": {
            "format": "uuid",
            "type": "string"
          },
          "performanceID": {
            "format": "uuid",
            "type": "string"
          },
          "rubricDetailID": {
            "format": "uuid",
            "type": "string"
          },
          "score": {
            "format": "double",
            "type": "number"
          },
          "comment": {
            "type": "string"
          },
          "createdBy": {
            "format": "uuid",
            "type": "string"
          },
          "createdDate": {
            "format": "date-time",
            "type": "string"
          },
          "updatedBy": {
            "format": "uuid",
            "type": "string"
          },
          "updatedDate": {
            "format": "date-time",
            "type": "string"
          }
        }
      }
    },
    "id": {
      "format": "uuid",
      "description": "ID of the Mark/Comment",
      "type": "string"
    },
    "targetID": {
      "format": "uuid",
      "description": "Target ID which this comment/mark for",
      "type": "string"
    },
    "resourceID": {
      "format": "uuid",
      "description": "the folder ID  or tool ID which contains this comment/mark",
      "type": "string"
    },
    "publish": {
      "description": "the publish flag which determine whether the record is published to students.",
      "type": "boolean"
    },
    "mark": {
      "format": "float",
      "description": "Marks entered for the student",
      "type": "number"
    },
    "moderation": {
      "format": "float",
      "description": "Moderation entered for the student",
      "type": "number"
    },
    "finalMark": {
      "format": "float",
      "description": "Final Mark for the student (computed column)",
      "type": "number"
    },
    "remark": {
      "description": "Remarks entered for the student",
      "type": "string"
    },
    "createdDate": {
      "format": "date-time",
      "description": "The date this grade item score is created",
      "type": "string"
    },
    "creatorID": {
      "format": "uuid",
      "description": "the ID of the user who created this grade item score",
      "type": "string"
    },
    "creatorName": {
      "description": "The name of the user who created the grade item score",
      "type": "string"
    },
    "creatorUserID": {
      "description": "The user ID of the user who created the grade item score",
      "type": "string"
    },
    "creatorEmail": {
      "description": "The email address of the user who created the grade item score",
      "type": "string"
    },
    "lastUpdatedDate": {
      "format": "date-time",
      "description": "the date this grade item score is last edited",
      "type": "string"
    },
    "lastUpdatedBy": {
      "format": "uuid",
      "description": "the ID of the user who edited this grade item score",
      "type": "string"
    },
    "lastUpdatedByName": {
      "description": "The name of the user who last updated the grade item score",
      "type": "string"
    },
    "lastUpdatedByUserID": {
      "description": "The user ID of the user who last updated the grade item score",
      "type": "string"
    },
    "lastUpdatedByEmail": {
      "description": "The email address of the user who last updated the grade item score",
      "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/Score/{ID}?AnonymousMarking={boolean}&AllowZeroComputation={boolean}&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["AnonymousMarking"] = "{boolean}";
            queryString["AllowZeroComputation"] = "{boolean}";
            queryString["populate"] = "{string}";
            var uri = "https://luminus.azure-api.net/gradebook/Score/{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/gradebook/Score/{ID}");

            builder.setParameter("AnonymousMarking", "{boolean}");
            builder.setParameter("AllowZeroComputation", "{boolean}");
            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
            "AnonymousMarking": "{boolean}",
            "AllowZeroComputation": "{boolean}",
            "populate": "{string}",
        };
      
        $.ajax({
            url: "https://luminus.azure-api.net/gradebook/Score/{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/gradebook/Score/{ID}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"AnonymousMarking={boolean}",
                         @"AllowZeroComputation={boolean}",
                         @"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/Score/{ID}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'AnonymousMarking' => '{boolean}',
    'AllowZeroComputation' => '{boolean}',
    '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
    'AnonymousMarking': '{boolean}',
    'AllowZeroComputation': '{boolean}',
    'populate': '{string}',
})

try:
    conn = httplib.HTTPSConnection('luminus.azure-api.net')
    conn.request("GET", "/gradebook/Score/{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
    'AnonymousMarking': '{boolean}',
    'AllowZeroComputation': '{boolean}',
    'populate': '{string}',
})

try:
    conn = http.client.HTTPSConnection('luminus.azure-api.net')
    conn.request("GET", "/gradebook/Score/{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/gradebook/Score/{ID}')

query = URI.encode_www_form({
    # Request parameters
    'AnonymousMarking' => '{boolean}',
    'AllowZeroComputation' => '{boolean}',
    '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