School (Beta)

This API is used to provide access to school information such as users, academics, admissions, athletics, content, lists, and general school info.

GET

Assignment list (single section)

Returns a list of assignments for a section. Requires Academic Group Manager in the K12 system.

Try it

Request URL

Request parameters

Parameter Required Type Description
section_id Property is required integer

The ID of the section.

types string

Returns results that match a comma separated list of assignment type IDs.

status string

The status of the assignment. The status corresponds with static system options.

persona_id integer

The ID of the persona to get assignments. 3 = Faculty, 2 = Student. Defaults to 3.

filter string

Return assignments based on the entered string: expired, future, or all. All is the default sort value.

search string

Returns results with Descriptions or Titles that match search 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, Implicit.

Response 200 OK

Success

{
  "count": 1,
  "value": [
    {
      "id": 7666244,
      "date": "2018-08-30T12:00:00+00:00",
      "description": "This is the description of the assignment",
      "discussion": false,
      "due_date": "2019-11-24T12:00:00+00:00",
      "enrolled": 0,
      "graded_count": 0,
      "index_id": 11967810,
      "major": false,
      "name": "Test API assignment",
      "publish_on_assigned": false,
      "published": true,
      "rank": 1,
      "type": "Lab",
      "type_id": 1705
    }
  ]
}
{
  "description": "A Collection",
  "type": "object",
  "properties": {
    "count": {
      "format": "int32",
      "description": "The number of items in the collection",
      "type": "integer",
      "readOnly": true
    },
    "next_link": {
      "description": "For paginated responses, the URI for the next page of results",
      "type": "string"
    },
    "value": {
      "description": "The set of items included in the response. This may be a subset of the items in the collection",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "description": "Assignment Model",
        "type": "object",
        "properties": {
          "id": {
            "format": "int32",
            "description": "The ID of the assignment",
            "type": "integer"
          },
          "date": {
            "format": "date-time",
            "description": "The date the assignment was assigned; Uses <a href=\"https://tools.ietf.org/html/rfc3339\" target=\"_blank\">ISO-8601</a> (24H) format: 2003-04-21T10:29:43",
            "type": "string"
          },
          "description": {
            "description": "The description of the assignment",
            "type": "string"
          },
          "discussion": {
            "description": "Returns True if Discussion is enabled; Discussion is a user-defined value.",
            "type": "boolean"
          },
          "due_date": {
            "format": "date-time",
            "description": "The date the assignment is due; Uses <a href=\"https://tools.ietf.org/html/rfc3339\" target=\"_blank\">ISO-8601</a> (24H) format: 2003-04-21T10:29:43",
            "type": "string"
          },
          "enrolled": {
            "format": "int32",
            "description": "The number of students enrolled in a class.",
            "type": "integer"
          },
          "graded_count": {
            "format": "int32",
            "description": "Returns the number of assignments that have been graded",
            "type": "integer"
          },
          "index_id": {
            "format": "int32",
            "description": "The index ID of the assignment",
            "type": "integer"
          },
          "major": {
            "description": "Whether the assignment is a major assignment or not; a major assignment is a user-defined value",
            "type": "boolean"
          },
          "name": {
            "description": "The name of the assignment",
            "type": "string"
          },
          "publish_on_assigned": {
            "description": "Returns True if assignment is published when it's assigned; based on the Date property",
            "type": "boolean"
          },
          "published": {
            "description": "Returns True if the assignment is published",
            "type": "boolean"
          },
          "rank": {
            "format": "int32",
            "description": "Gets or sets the rank of the assignment",
            "type": "integer"
          },
          "status": {
            "format": "int32",
            "description": "The status of the assignment",
            "type": "integer"
          },
          "type": {
            "description": "The assignment type (ex. Homework, Essay)",
            "type": "string"
          },
          "type_id": {
            "format": "int32",
            "description": "The Type ID of the assignment; the Type ID is a static system value.",
            "type": "integer"
          }
        }
      }
    }
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.sky.blackbaud.com/school/v1/academics/sections/{section_id}/assignments?types={string}&status={string}&persona_id={integer}&filter={string}&search={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["types"] = "{string}";
            queryString["status"] = "{string}";
            queryString["persona_id"] = "{integer}";
            queryString["filter"] = "{string}";
            queryString["search"] = "{string}";
            var uri = "https://api.sky.blackbaud.com/school/v1/academics/sections/{section_id}/assignments?" + 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/sections/{section_id}/assignments");

            builder.setParameter("types", "{string}");
            builder.setParameter("status", "{string}");
            builder.setParameter("persona_id", "{integer}");
            builder.setParameter("filter", "{string}");
            builder.setParameter("search", "{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
            "types": "{string}",
            "status": "{string}",
            "persona_id": "{integer}",
            "filter": "{string}",
            "search": "{string}",
        };

        $.ajax({
            url: "https://api.sky.blackbaud.com/school/v1/academics/sections/{section_id}/assignments?" + $.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/sections/{section_id}/assignments";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"types={string}",
                         @"status={string}",
                         @"persona_id={integer}",
                         @"filter={string}",
                         @"search={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/sections/{section_id}/assignments');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'types' => '{string}',
    'status' => '{string}',
    'persona_id' => '{integer}',
    'filter' => '{string}',
    'search' => '{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
    'types': '{string}',
    'status': '{string}',
    'persona_id': '{integer}',
    'filter': '{string}',
    'search': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/school/v1/academics/sections/{section_id}/assignments?%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
    'types': '{string}',
    'status': '{string}',
    'persona_id': '{integer}',
    'filter': '{string}',
    'search': '{string}',
})

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

query = URI.encode_www_form({
    # Request parameters
    'types' => '{string}',
    'status' => '{string}',
    'persona_id' => '{integer}',
    'filter' => '{string}',
    'search' => '{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 API team? Please visit us on the SKY API Community!