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 by role(s)
Returns a paginated collection of users, limited to 100 users per page.
Use the record number as the marker value to return the next set of results. For example: marker=101 will return the second set of results.
Results dependant on the directory settings of each user.
Requires at least one of the following roles in the Education Management system:
- Billing Clerk
- Password Manager
- Contact Card Manager
- Platform Manager
Request URL
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| roles | Property is required | string | Comma delimited list of role IDs to get users for. |
| first_name | string | Filter results by first name. |
|
| last_name | string | Filter results by last name. |
|
| string | Filter results by e-mail. |
||
| maiden_name | string | Filter results by maiden name. |
|
| grad_year | string | The beginning date in a school year (ex. 2017). |
|
| end_grad_year | string | The end date in a school year (ex. 2018). Enter a grad_year and end_grad_year to find matching results in the date range. |
|
| marker | integer | The record number start at to return the next batch of data. |
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,
"next_link": "/v1/users/?roles=4180&marker=101",
"value": [
{
"id": 1,
"deceased": false,
"display": "John Smith",
"email": "example@example.com",
"email_active": true,
"first_name": "John",
"last_name": "Smith",
"lost": false,
"maiden_name": "",
"middle_name": "Nolan",
"nick_name": "Jonny",
"preferred_name": "SuperStar",
"dob": "2002-10-15T00:00:00Z",
"prefix": "Mr.",
"suffix": "III"
}
]
}{
"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 associated with a user",
"format": "int32"
},
"affiliation": {
"type": "string",
"description": "The affiliation of a user",
"nullable": true
},
"custom_field_eight": {
"type": "string",
"description": "A custom field on the user profile (eight of ten)",
"nullable": true
},
"custom_field_five": {
"type": "string",
"description": "A custom field on the user profile (five of ten)",
"nullable": true
},
"custom_field_four": {
"type": "string",
"description": "A custom field on the user profile (four of ten)",
"nullable": true
},
"custom_field_nine": {
"type": "string",
"description": "A custom field on the user profile (nine of ten)",
"nullable": true
},
"custom_field_one": {
"type": "string",
"description": "A custom field on the user profile (one of ten)",
"nullable": true
},
"custom_field_seven": {
"type": "string",
"description": "A custom field on the user profile (seven of ten)",
"nullable": true
},
"custom_field_six": {
"type": "string",
"description": "A custom field on the user profile (six of ten)",
"nullable": true
},
"custom_field_ten": {
"type": "string",
"description": "A custom field on the user profile (ten of ten)",
"nullable": true
},
"custom_field_three": {
"type": "string",
"description": "A custom field on the user profile (three of ten)",
"nullable": true
},
"custom_field_two": {
"type": "string",
"description": "A custom field on the user profile (two of ten)",
"nullable": true
},
"deceased": {
"type": "boolean",
"description": "Returns true if deceased is selected under sensitive information in a personal profile ex: {last_name} {suffix*}, {first_name} {(maidenname*}) {grad_year*} *If not populated fields will not appear (read only)"
},
"display": {
"type": "string",
"description": "Display name field generated from first name, last name, nickname, and grad year (read only)",
"nullable": true
},
"email": {
"type": "string",
"description": "The email address of a user",
"nullable": true
},
"email_active": {
"type": "boolean",
"description": "Returns true if the users e-mail is ok to send to"
},
"first_name": {
"type": "string",
"description": "The first name of a user",
"nullable": true
},
"gender": {
"type": "string",
"description": "The gender of a user",
"nullable": true
},
"gender_description": {
"type": "string",
"description": "The gender of a user",
"nullable": true
},
"greeting": {
"type": "string",
"description": "The greeting of a user",
"nullable": true
},
"host_id": {
"type": "string",
"description": "The HostId of a user",
"nullable": true
},
"last_name": {
"type": "string",
"description": "The last name of a user",
"nullable": true
},
"lost": {
"type": "boolean",
"description": "Returns true if lost is selected under sensitive information in a personal profile (read only)"
},
"maiden_name": {
"type": "string",
"description": "The maiden name of a user",
"nullable": true
},
"middle_name": {
"type": "string",
"description": "The middle name of a user",
"nullable": true
},
"nick_name": {
"type": "string",
"description": "The nickname of a user\r\n<b>This field will be deprecated after 90 days.</b>",
"nullable": true
},
"preferred_name": {
"type": "string",
"description": "The preferred name of the user",
"nullable": true
},
"dob": {
"type": "string",
"description": "Users date of birth",
"format": "date-time",
"nullable": true
},
"prefix": {
"type": "string",
"description": "The prefix of a user",
"nullable": true
},
"suffix": {
"type": "string",
"description": "The suffix of a user",
"nullable": true
},
"profile_pictures": {
"type": "object",
"properties": {
"large_filename_url": {
"type": "string",
"description": "URL to users Large profile picture",
"nullable": true
},
"thumb_filename_url": {
"type": "string",
"description": "URL to users Thumbnail profile picture",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
}
},
"additionalProperties": false,
"description": "UserRead 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/users?roles={roles}?first_name={string}&last_name={string}&email={string}&maiden_name={string}&grad_year={string}&end_grad_year={string}&marker={integer}"
-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["first_name"] = "{string}";
queryString["last_name"] = "{string}";
queryString["email"] = "{string}";
queryString["maiden_name"] = "{string}";
queryString["grad_year"] = "{string}";
queryString["end_grad_year"] = "{string}";
queryString["marker"] = "{integer}";
var uri = "https://api.sky.blackbaud.com/school/v1/users?roles={roles}&" + 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?roles={roles}");
builder.setParameter("first_name", "{string}");
builder.setParameter("last_name", "{string}");
builder.setParameter("email", "{string}");
builder.setParameter("maiden_name", "{string}");
builder.setParameter("grad_year", "{string}");
builder.setParameter("end_grad_year", "{string}");
builder.setParameter("marker", "{integer}");
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
"first_name": "{string}",
"last_name": "{string}",
"email": "{string}",
"maiden_name": "{string}",
"grad_year": "{string}",
"end_grad_year": "{string}",
"marker": "{integer}",
};
$.ajax({
url: "https://api.sky.blackbaud.com/school/v1/users?roles={roles}&" + $.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?roles={roles}";
NSArray* array = @[
// Request parameters
@"entities=true",
@"first_name={string}",
@"last_name={string}",
@"email={string}",
@"maiden_name={string}",
@"grad_year={string}",
@"end_grad_year={string}",
@"marker={integer}",
];
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?roles={roles}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Bb-Api-Subscription-Key' => '{subscription key}',
'Authorization' => 'Bearer {access token}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'first_name' => '{string}',
'last_name' => '{string}',
'email' => '{string}',
'maiden_name' => '{string}',
'grad_year' => '{string}',
'end_grad_year' => '{string}',
'marker' => '{integer}',
);
$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
'first_name': '{string}',
'last_name': '{string}',
'email': '{string}',
'maiden_name': '{string}',
'grad_year': '{string}',
'end_grad_year': '{string}',
'marker': '{integer}',
})
try:
conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/school/v1/users?roles={roles}&%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
'first_name': '{string}',
'last_name': '{string}',
'email': '{string}',
'maiden_name': '{string}',
'grad_year': '{string}',
'end_grad_year': '{string}',
'marker': '{integer}',
})
try:
conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/school/v1/users?roles={roles}&%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?roles={roles}')
query = URI.encode_www_form({
# Request parameters
'first_name' => '{string}',
'last_name' => '{string}',
'email' => '{string}',
'maiden_name' => '{string}',
'grad_year' => '{string}',
'end_grad_year' => '{string}',
'marker' => '{integer}'
})
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