School
This API is used to provide access to school information such as users, academics, admissions, athletics, content, lists, and general school info.
GET
Academics graded assignments for student
Returns the graded assignments for the specified student_id and their section_id.
Requires at least one of the following roles in the Education Management system:
- Student
- Parent
Request URL
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| student_id | Property is required | integer | The ID of the student to view graded assignments for. |
| section_id | Property is required | integer | The ID of the lead section for the student. |
| marking_period_id | Property is required | integer | The ID of the marking period to return grades for. |
Request headers
| Header | Required | Type | Description |
|---|---|---|---|
| Bb-Api-Subscription-Key | Property is required | string | Subscription key which provides access to this API. Found in your Profile. |
| Authorization | Property is required | string | OAuth 2.0 access token obtained from Blackbaud OAuth 2.0 Service. Supported grant types: Authorization code. |
Response 200 OK
Success
{
"count": 1,
"value": [
{
"assignment_id": 123456,
"assignment_index_id": 56789,
"short_description": "Chapter 5 Notes",
"date_assigned": "2022-04-22T08:00:00Z",
"date_due": "2022-04-24T08:00:00Z",
"max_points": 20.0,
"points": 18.0,
"assignment_percentage": 80.0,
"letter": "B+",
"section_grade": 92.69,
"formative": false,
"missing": false,
"late": false,
"incomplete": true,
"exempt": false,
"comment": "You skipped one question.",
"assignment_type": {
"id": 98,
"name": "Homework",
"percentage": "92.56",
"weight": 80.0
}
}
]
}{
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "The number of items in the collection",
"format": "int32",
"readOnly": true
},
"next_link": {
"type": "string",
"description": "For paginated responses, the URI for the next page of results",
"nullable": true
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"assignment_id": {
"type": "integer",
"description": "The ID of the assignment",
"format": "int32",
"nullable": true
},
"assignment_index_id": {
"type": "integer",
"description": "The index ID of the assignment",
"format": "int32",
"nullable": true
},
"short_description": {
"type": "string",
"description": "The short description for the assignment",
"nullable": true
},
"date_assigned": {
"type": "string",
"description": "The date the assignment was assigned",
"format": "date-time",
"nullable": true
},
"date_due": {
"type": "string",
"description": "The date the assignment is due",
"format": "date-time",
"nullable": true
},
"max_points": {
"type": "number",
"description": "The maximum points for the assignment",
"format": "float",
"nullable": true
},
"points": {
"type": "number",
"description": "The graded number of points for the assignment",
"format": "float",
"nullable": true
},
"assignment_percentage": {
"type": "number",
"description": "The percentage grade for the assignment",
"format": "float",
"nullable": true
},
"letter": {
"type": "string",
"description": "The letter grade for the assignment",
"nullable": true
},
"section_grade": {
"type": "number",
"description": "The cumulative grade for the section",
"format": "float",
"nullable": true
},
"formative": {
"type": "boolean",
"description": "Returns true if the assignment is formative",
"nullable": true
},
"missing": {
"type": "boolean",
"description": "Returns true if the assignment is missing",
"nullable": true
},
"late": {
"type": "boolean",
"description": "Returns true if the assignment is late",
"nullable": true
},
"incomplete": {
"type": "boolean",
"description": "Returns true if the assignment is incomplete",
"nullable": true
},
"exempt": {
"type": "boolean",
"description": "Returns true if the assignment is exempt",
"nullable": true
},
"comment": {
"type": "string",
"description": "Comment for the assignment",
"nullable": true
},
"assignment_type": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID for the assignment type",
"format": "int32",
"nullable": true
},
"name": {
"type": "string",
"description": "The name of the assignment type",
"nullable": true
},
"percentage": {
"type": "string",
"description": "The calculated percentage for the assignment type for this section",
"nullable": true
},
"weight": {
"type": "number",
"description": "The weight applied to the assignment type",
"format": "float",
"nullable": true
}
},
"additionalProperties": false,
"description": "Assignment Type Model"
}
},
"additionalProperties": false,
"description": "Student Graded Assignments Model"
},
"description": "The set of items included in the response. This may be a subset of the items in the collection",
"nullable": true
}
},
"additionalProperties": false,
"description": "A Collection"
}Code samples
@ECHO OFF
curl -v -X GET "https://api.sky.blackbaud.com/school/v1/academics/{student_id}/{section_id}/gradedassignments?marking_period_id={marking_period_id}"
-H "Bb-Api-Subscription-Key: {subscription key}"
-H "Authorization: Bearer {access token}"
--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("Bb-Api-Subscription-Key", "{subscription key}");
client.DefaultRequestHeaders.Add("Authorization", "Bearer {access token}");
var uri = "https://api.sky.blackbaud.com/school/v1/academics/{student_id}/{section_id}/gradedassignments?marking_period_id={marking_period_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://api.sky.blackbaud.com/school/v1/academics/{student_id}/{section_id}/gradedassignments?marking_period_id={marking_period_id}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Bb-Api-Subscription-Key", "{subscription key}");
request.setHeader("Authorization", "Bearer {access token}");
// 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
};
$.ajax({
url: "https://api.sky.blackbaud.com/school/v1/academics/{student_id}/{section_id}/gradedassignments?marking_period_id={marking_period_id}&" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Bb-Api-Subscription-Key","{subscription key}");
xhrObj.setRequestHeader("Authorization","Bearer {access token}");
},
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://api.sky.blackbaud.com/school/v1/academics/{student_id}/{section_id}/gradedassignments?marking_period_id={marking_period_id}";
NSArray* array = @[
// Request parameters
@"entities=true",
];
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:@"Bb-Api-Subscription-Key"];
[_request setValue:@"Bearer {access token}" forHTTPHeaderField:@"Authorization"];
// 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 PEAR HTTP client from http://pear.php.net/package/HTTP_Request2
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api.sky.blackbaud.com/school/v1/academics/{student_id}/{section_id}/gradedassignments?marking_period_id={marking_period_id}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Bb-Api-Subscription-Key' => '{subscription key}',
'Authorization' => 'Bearer {access token}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$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
'Bb-Api-Subscription-Key': '{subscription key}',
'Authorization': 'Bearer {access token}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/school/v1/academics/{student_id}/{section_id}/gradedassignments?marking_period_id={marking_period_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
'Bb-Api-Subscription-Key': '{subscription key}',
'Authorization': 'Bearer {access token}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/school/v1/academics/{student_id}/{section_id}/gradedassignments?marking_period_id={marking_period_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://api.sky.blackbaud.com/school/v1/academics/{student_id}/{section_id}/gradedassignments?marking_period_id={marking_period_id}')
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Bb-Api-Subscription-Key'] = '{subscription key}'
request['Authorization'] = 'Bearer {access token}'
# 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
Comments