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 student enrollment list

Returns a collection of course sections in which the provided student is enrolled.
Requires at least one of the following roles in the Education Management system:

  • Academic Group Manager
  • Schedule Manager

Try it

Request URL

Request parameters

Parameter Required Type Description
user_id Property is required integer

User identifier.
school_year string

The school year to filter the collection of sections by. Corresponds to school_year_label in the Year list. Defaults to the current school year.

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": 21890883,
      "begin_date": "2018-08-30T12:00:00Z",
      "block_id": 1966,
      "block_name": "A",
      "blocks": true,
      "building_name": "Alumni Hall",
      "course_code": "AL1",
      "course_title": "Arthurian Legends",
      "departments": [
        {
          "id": 1,
          "level_description": "Level Description",
          "name": "English",
          "sort": 1
        }
      ],
      "distinction": "",
      "dropped": 0,
      "duration_begin_date": "2018-11-25T12:00:00Z",
      "duration_description": "Fall",
      "duration_end_date": "2019-02-01T12:00:00Z",
      "duration_id": 78739,
      "duration_name": "Fall",
      "end_date": "2019-11-24T12:00:00Z",
      "faculty_first_name": "Ian",
      "faculty_last_name": "Smith",
      "level_number": 455,
      "offering_description": "Athletics",
      "offering_id": 263402,
      "offering_type_id": 9,
      "room_id": 6959,
      "room_name": "107 update",
      "room_number": "Alu. 107",
      "school_year": "2017 - 2018",
      "section_identifier": "1"
    }
  ]
}
{
  "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": {
          "id": {
            "type": "integer",
            "description": "The ID of the section",
            "format": "int32",
            "nullable": true
          },
          "begin_date": {
            "type": "string",
            "description": "The begin date of the course. Uses <a href=\"https://tools.ietf.org/html/rfc3339\" target=\"_blank\">ISO-8601</a> (24H) format: 2003-04-21T10:29:43",
            "format": "date-time"
          },
          "block_id": {
            "type": "integer",
            "description": "The block ID for a section",
            "format": "int32",
            "nullable": true
          },
          "block_name": {
            "type": "string",
            "description": "The block name for a section",
            "nullable": true
          },
          "blocks": {
            "type": "boolean",
            "description": "Returns true if the course has blocks"
          },
          "building_name": {
            "type": "string",
            "description": "The building name",
            "nullable": true
          },
          "changed_sections": {
            "type": "integer",
            "description": "changed sections",
            "format": "int32",
            "nullable": true
          },
          "course_code": {
            "type": "string",
            "description": "The identifier used to reference a course; the Course Code is a user-entered value",
            "nullable": true
          },
          "course_length": {
            "type": "integer",
            "description": "The length of a course",
            "format": "int32",
            "nullable": true
          },
          "course_title": {
            "type": "string",
            "description": "The title of the course",
            "nullable": true
          },
          "departments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer",
                  "description": "The ID of the department",
                  "format": "int32",
                  "nullable": true
                },
                "level_description": {
                  "type": "string",
                  "description": "The description of the level this department is associated with",
                  "nullable": true
                },
                "name": {
                  "type": "string",
                  "description": "The name of the department",
                  "nullable": true
                },
                "sort": {
                  "type": "integer",
                  "description": "The sort order of the department",
                  "format": "int32",
                  "nullable": true
                }
              },
              "additionalProperties": false,
              "description": "Department model"
            },
            "description": "The list of departments the section is associated with",
            "nullable": true
          },
          "distinction": {
            "type": "string",
            "description": "distinction",
            "nullable": true
          },
          "dropped": {
            "type": "integer",
            "description": "was the course dropped",
            "format": "int32",
            "nullable": true
          },
          "duration_begin_date": {
            "type": "string",
            "description": "The begin date of the duration. Uses <a href=\"https://tools.ietf.org/html/rfc3339\" target=\"_blank\">ISO-8601</a> (24H) format: 2003-04-21T10:29:43",
            "format": "date-time"
          },
          "duration_description": {
            "type": "string",
            "description": "The description of the starting term of the section",
            "nullable": true
          },
          "duration_end_date": {
            "type": "string",
            "description": "The end date of the duration. Uses <a href=\"https://tools.ietf.org/html/rfc3339\" target=\"_blank\">ISO-8601</a> (24H) format: 2003-04-21T10:29:43",
            "format": "date-time"
          },
          "duration_id": {
            "type": "integer",
            "description": "The duration ID for a section",
            "format": "int32"
          },
          "duration_name": {
            "type": "string",
            "description": "The starting term of the section",
            "nullable": true
          },
          "end_date": {
            "type": "string",
            "description": "The end date of the course. Uses <a href=\"https://tools.ietf.org/html/rfc3339\" target=\"_blank\">ISO-8601</a> (24H) format: 2003-04-21T10:29:43",
            "format": "date-time"
          },
          "faculty_first_name": {
            "type": "string",
            "description": "The first name of the head teacher",
            "nullable": true
          },
          "faculty_last_name": {
            "type": "string",
            "description": "The last name of the head teacher",
            "nullable": true
          },
          "level_number": {
            "type": "integer",
            "description": "level number",
            "format": "int32"
          },
          "offering_description": {
            "type": "string",
            "description": "The description of an offering type",
            "nullable": true
          },
          "offering_id": {
            "type": "integer",
            "description": "The ID of an offered course",
            "format": "int32",
            "nullable": true
          },
          "offering_type_id": {
            "type": "integer",
            "description": "The ID of an offering type",
            "format": "int32",
            "nullable": true
          },
          "room_id": {
            "type": "integer",
            "description": "The room ID for a section",
            "format": "int32",
            "nullable": true
          },
          "room_name": {
            "type": "string",
            "description": "The room name for the section",
            "nullable": true
          },
          "room_number": {
            "type": "string",
            "description": "The room number for the section",
            "nullable": true
          },
          "school_year": {
            "type": "string",
            "description": "The school year date range in which the section occurs",
            "nullable": true
          },
          "section_identifier": {
            "type": "string",
            "description": "The identifier used to differentiate between multiple sections that contain a course; the Section Identifier is a user-entered value",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Section 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/enrollments/{user_id}?school_year={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["school_year"] = "{string}";
            var uri = "https://api.sky.blackbaud.com/school/v1/academics/enrollments/{user_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/enrollments/{user_id}");

            builder.setParameter("school_year", "{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
            "school_year": "{string}",
        };

        $.ajax({
            url: "https://api.sky.blackbaud.com/school/v1/academics/enrollments/{user_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/enrollments/{user_id}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"school_year={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/enrollments/{user_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
    'school_year' => '{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
    'school_year': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/school/v1/academics/enrollments/{user_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({
    # Request parameters
    'school_year': '{string}',
})

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

query = URI.encode_www_form({
    # Request parameters
    'school_year' => '{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!