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 assignments for student

Returns assignments for a student that are assigned or due within the date range specified.
If no end_date is supplied it defaults to 31 days past the start_date Requires at least one of the following roles in the Education Management system:

  • Student
  • Parent

Try it

Request URL

Request parameters

Parameter Required Type Description
student_id Property is required integer

Format - int32.
start_date Property is required string

Format - date-time (as date-time in RFC3339).
end_date string

Format - date-time (as date-time in RFC3339).
section_ids string

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": 2,
  "value": [
    {
      "section_name": "English III",
      "section_id": 1,
      "assignment_id": 1,
      "short_description": "A short description of the assignment",
      "date_assigned": "2022-04-22T00:00:00Z",
      "date_due": "2022-04-30T00:00:00Z",
      "long_description": "A long description of the assignment",
      "assignment_type": "Homework",
      "grade_book": false,
      "online_submission": true,
      "assignment_status": 1,
      "assessment": false,
      "assessment_locked": false,
      "major": 0,
      "discussion": false,
      "formative": false,
      "exempt": false,
      "incomplete": false,
      "late": false,
      "missing": false,
      "rubric": false,
      "user_task": false
    },
    {
      "section_name": "English III",
      "section_id": 1,
      "assignment_id": 1,
      "short_description": "A short description of the assignment",
      "date_assigned": "2022-04-22T00:00:00Z",
      "date_due": "2022-04-30T00:00:00Z",
      "long_description": "A long description of the assignment",
      "assignment_type": "Homework",
      "grade_book": false,
      "online_submission": true,
      "assignment_status": 1,
      "assessment": false,
      "assessment_locked": false,
      "major": 0,
      "discussion": false,
      "formative": false,
      "exempt": false,
      "incomplete": false,
      "late": false,
      "missing": false,
      "rubric": false,
      "user_task": false
    }
  ]
}
{
  "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": {
          "section_name": {
            "type": "string",
            "description": "The name of the section the assignment was assigned in",
            "nullable": true
          },
          "section_id": {
            "type": "integer",
            "description": "The id of the section the assignment was assigned in",
            "format": "int32",
            "nullable": true
          },
          "assignment_id": {
            "type": "integer",
            "description": "The 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
          },
          "long_description": {
            "type": "string",
            "description": "The long description of the assignment",
            "nullable": true
          },
          "assignment_type": {
            "type": "string",
            "description": "The type of the assignment",
            "nullable": true
          },
          "grade_book": {
            "type": "boolean",
            "description": "Returns true if the assignment is included in the GradeBook"
          },
          "online_submission": {
            "type": "boolean",
            "description": "Returns true if the assignment is an online submission assignment"
          },
          "assignment_status": {
            "type": "integer",
            "description": "The status of the assignment",
            "format": "int32",
            "nullable": true
          },
          "assessment": {
            "type": "boolean",
            "description": "Returns true if this assignment is an assessment"
          },
          "assessment_id": {
            "type": "integer",
            "description": "The id of the assessment",
            "format": "int32",
            "nullable": true
          },
          "assessment_locked": {
            "type": "boolean",
            "description": "Returns true if the assessment is locked"
          },
          "major": {
            "type": "integer",
            "description": "",
            "format": "int32",
            "nullable": true
          },
          "discussion": {
            "type": "boolean",
            "description": "Returns true if the assignment has a discussion"
          },
          "formative": {
            "type": "boolean",
            "description": "Returns true if the assignment is formative"
          },
          "exempt": {
            "type": "boolean",
            "description": "Returns true if ther student is exempt from this assignment"
          },
          "incomplete": {
            "type": "boolean",
            "description": "Returns true if the assignment is incomplete"
          },
          "late": {
            "type": "boolean",
            "description": "Returns true if the assignment is late"
          },
          "missing": {
            "type": "boolean",
            "description": "Returns true if the assignment is missing"
          },
          "rubric": {
            "type": "boolean",
            "description": "Returns true if the assignment is included in the rubric"
          },
          "user_task": {
            "type": "boolean",
            "description": "Returns true if the assignment is a user generated task"
          }
        },
        "additionalProperties": false,
        "description": ""
      },
      "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}/assignments?start_date={start_date}?end_date={string}&section_ids={string}"
-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}");

            // Request parameters
            queryString["end_date"] = "{string}";
            queryString["section_ids"] = "{string}";
            var uri = "https://api.sky.blackbaud.com/school/v1/academics/{student_id}/assignments?start_date={start_date}&" + 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}/assignments?start_date={start_date}");

            builder.setParameter("end_date", "{string}");
            builder.setParameter("section_ids", "{string}");

            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
            "end_date": "{string}",
            "section_ids": "{string}",
        };

        $.ajax({
            url: "https://api.sky.blackbaud.com/school/v1/academics/{student_id}/assignments?start_date={start_date}&" + $.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}/assignments?start_date={start_date}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"end_date={string}",
                         @"section_ids={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:@"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}/assignments?start_date={start_date}');
$url = $request->getUrl();

$headers = array(
    // Request headers
   'Bb-Api-Subscription-Key' => '{subscription key}',
   'Authorization' => 'Bearer {access token}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'end_date' => '{string}',
    'section_ids' => '{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
    'Bb-Api-Subscription-Key': '{subscription key}',
    'Authorization': 'Bearer {access token}',
}

params = urllib.urlencode({
    # Request parameters
    'end_date': '{string}',
    'section_ids': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/school/v1/academics/{student_id}/assignments?start_date={start_date}&%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({
    # Request parameters
    'end_date': '{string}',
    'section_ids': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/school/v1/academics/{student_id}/assignments?start_date={start_date}&%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}/assignments?start_date={start_date}')

query = URI.encode_www_form({
    # Request parameters
    'end_date' => '{string}',
    'section_ids' => '{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['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

Have a question? See a problem with our docs? Want to engage with the SKY Developer team? Please visit us on the SKY Developer Community!