School
This API is used to provide access to school information such as users, academics, admissions, athletics, content, lists, and general school info.
GET
Users enrollments by year (BETA)
Returns a collection of users and their enrollments for a single school year.
Requires at least one of the following roles in the Education Management system:
- Admissions manager
- Platform manager
- SKY API Data Sync
This endpoint is in BETA. It may be removed or replaced with a 90 day deprecation period.
Try itRequest URL
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| school_year | Property is required | string | The school year label to get enrollments for. The school year should be formatted like |
| school_level_id | integer | The school level Id to return enrollments for. Optional. |
|
| grade_level_id | integer | The grade level Id to return enrollments for. Optional. |
|
| limit | integer | The number of records to return. Defaults to 1000. Maximum is 5000. |
|
| offset | integer | The record to start the next collection on. Defaults to 0. |
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,
"next_link": "/v1/users/enrollments?school_year=2022-2023",
"value": [
{
"user_id": 1234,
"firstname": "John",
"lastname": "Smith",
"preferred_name": "Jon",
"name": "Jon Smith",
"school_year": "2022-2023",
"school_level": {
"id": 435,
"abbreviation": "US",
"name": "Upper School"
},
"grade_level": {
"id": 4001,
"active": true,
"description": "12",
"name": "12",
"promote_to_code": 12345
},
"repeated": false,
"graduated": false,
"enroll_date": "2022-09-10T08:00:00Z",
"depart_date": "2023-05-23T08:00:00Z",
"depart_reason": "This will be a custom depart reason",
"session": "Fall Semester"
}
]
}{
"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": {
"user_id": {
"type": "integer",
"description": "The id of the user",
"format": "int32",
"nullable": true
},
"firstname": {
"type": "string",
"description": "The first name of the user",
"nullable": true
},
"lastname": {
"type": "string",
"description": "The last name of the user",
"nullable": true
},
"preferred_name": {
"type": "string",
"description": "The preferred name of the user",
"nullable": true
},
"name": {
"type": "string",
"description": "The formatted name of the user",
"nullable": true
},
"school_year": {
"type": "string",
"description": "The school year the user is enrolled in",
"nullable": true
},
"school_level": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of a school level",
"format": "int32",
"nullable": true
},
"abbreviation": {
"type": "string",
"description": "The abbreviation associated with a school level",
"nullable": true
},
"name": {
"type": "string",
"description": "The label used to identify a school level",
"nullable": true
}
},
"additionalProperties": false,
"description": "Level Model"
},
"grade_level": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of a grade level",
"format": "int32",
"nullable": true
},
"active": {
"type": "boolean",
"description": "Returns true if the grade level is active",
"nullable": true
},
"description": {
"type": "string",
"description": "The description of the grade level",
"nullable": true
},
"abbreviation": {
"type": "string",
"description": "The abbreviation of the grade level",
"nullable": true
},
"name": {
"type": "string",
"description": "The label used to identify a grade level",
"nullable": true
},
"promote_to_code": {
"type": "integer",
"description": "Returns integer value denoting what promotion a student receives when completing this grade, 1 = Promoted to next grade level, 2 = Graduate, 3 = No action",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "GradeLevel Model"
},
"repeated": {
"type": "boolean",
"description": "Returns true if the user repeated this enrollment",
"nullable": true
},
"graduated": {
"type": "boolean",
"description": "Returns true if the user graduated after completing this enrollment year",
"nullable": true
},
"enroll_date": {
"type": "string",
"description": "The date the enrollment begins",
"format": "date-time",
"nullable": true
},
"depart_date": {
"type": "string",
"description": "The date the user departed the school year, ending the enrollment",
"format": "date-time",
"nullable": true
},
"depart_reason": {
"type": "string",
"description": "The reason the user departed the school",
"nullable": true
},
"session": {
"type": "string",
"description": "The name of the session, if a session is attached to the enrollment",
"nullable": true
}
},
"additionalProperties": false,
"description": "User Enrollment"
},
"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/users/enrollments?school_year={school_year}?school_level_id={integer}&grade_level_id={integer}&limit=1000&offset=0"
-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_level_id"] = "{integer}";
queryString["grade_level_id"] = "{integer}";
queryString["limit"] = "1000";
queryString["offset"] = "0";
var uri = "https://api.sky.blackbaud.com/school/v1/users/enrollments?school_year={school_year}&" + 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/users/enrollments?school_year={school_year}");
builder.setParameter("school_level_id", "{integer}");
builder.setParameter("grade_level_id", "{integer}");
builder.setParameter("limit", "1000");
builder.setParameter("offset", "0");
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_level_id": "{integer}",
"grade_level_id": "{integer}",
"limit": "1000",
"offset": "0",
};
$.ajax({
url: "https://api.sky.blackbaud.com/school/v1/users/enrollments?school_year={school_year}&" + $.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/users/enrollments?school_year={school_year}";
NSArray* array = @[
// Request parameters
@"entities=true",
@"school_level_id={integer}",
@"grade_level_id={integer}",
@"limit=1000",
@"offset=0",
];
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/users/enrollments?school_year={school_year}');
$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_level_id' => '{integer}',
'grade_level_id' => '{integer}',
'limit' => '1000',
'offset' => '0',
);
$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_level_id': '{integer}',
'grade_level_id': '{integer}',
'limit': '1000',
'offset': '0',
})
try:
conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/school/v1/users/enrollments?school_year={school_year}&%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_level_id': '{integer}',
'grade_level_id': '{integer}',
'limit': '1000',
'offset': '0',
})
try:
conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/school/v1/users/enrollments?school_year={school_year}&%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/users/enrollments?school_year={school_year}')
query = URI.encode_www_form({
# Request parameters
'school_level_id' => '{integer}',
'grade_level_id' => '{integer}',
'limit' => '1000',
'offset' => '0'
})
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