School

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

GET

Calendar for User (BETA)

Returns a list of events for the calling user. Requires one of the following roles in the Education Management system:

  • Student
  • Parent
  • Teacher

This endpoint is in BETA. It may be removed or replaced with a 90 day deprecation period.

Try it

Request URL

Request parameters

Parameter Required Type Description
start_date string

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

end_date string

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

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": [
    {
      "association_id": 1,
      "brief_description": "Brief description of the event",
      "building_name": "Main Building",
      "cancelled": false,
      "contact_email": "example@example.com",
      "contact_name": "John Doe",
      "end_date": "2022-01-01T14:00:00Z",
      "event_id": 1,
      "event_type": "1",
      "category_id": 1,
      "category_name": "School Events",
      "home_away": "",
      "invitational": false,
      "league": false,
      "location": "Event Location",
      "long_description": "Long Description of the event",
      "opponent": "",
      "playoff": false,
      "preset_id": 1,
      "rescheduled": false,
      "reschedule_note": "",
      "room_name": "Main Room",
      "scrimmage": false,
      "start_date": "2022-01-01T13:00:00Z",
      "title": "Event Name",
      "tournament": false,
      "all_day": false,
      "total_days": 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": {
          "association_id": {
            "type": "integer",
            "description": "The association id for the event",
            "format": "int32",
            "nullable": true
          },
          "brief_description": {
            "type": "string",
            "description": "The brief description of the event",
            "nullable": true
          },
          "building_name": {
            "type": "string",
            "description": "The name of the building where the event is being held",
            "nullable": true
          },
          "cancelled": {
            "type": "boolean",
            "description": "If the event is an athletic game, returns true if it is canceled",
            "nullable": true
          },
          "contact_email": {
            "type": "string",
            "description": "The email of the event contact",
            "nullable": true
          },
          "contact_name": {
            "type": "string",
            "description": "The name of the event contact",
            "nullable": true
          },
          "end_date": {
            "type": "string",
            "description": "The date the event ends",
            "format": "date-time",
            "nullable": true
          },
          "event_id": {
            "type": "integer",
            "description": "The id of the event",
            "format": "int32",
            "nullable": true
          },
          "event_type": {
            "type": "string",
            "description": "The type of the event",
            "nullable": true
          },
          "category_id": {
            "type": "integer",
            "description": "The id of the category the event belongs to",
            "format": "int32",
            "nullable": true
          },
          "category_name": {
            "type": "string",
            "description": "The name of the category the event belongs to",
            "nullable": true
          },
          "home_away": {
            "type": "string",
            "description": "If the event is an athletic game, returns the home or away status of the game",
            "nullable": true
          },
          "invitational": {
            "type": "boolean",
            "description": "If the event is an athletic game, returns true if the game is an invitational",
            "nullable": true
          },
          "league": {
            "type": "boolean",
            "description": "If the event is an athletic game, returns true if the game is a league game",
            "nullable": true
          },
          "location": {
            "type": "string",
            "description": "The location of the event",
            "nullable": true
          },
          "long_description": {
            "type": "string",
            "description": "The long description of the event",
            "nullable": true
          },
          "opponent": {
            "type": "string",
            "description": "If the event is an athletic game, returns the name of the opponent",
            "nullable": true
          },
          "playoff": {
            "type": "boolean",
            "description": "If the event is an athletic game, returns true if the game is a playoff game",
            "nullable": true
          },
          "preset_id": {
            "type": "integer",
            "description": "The event preset id",
            "format": "int32",
            "nullable": true
          },
          "recurrence_id": {
            "type": "integer",
            "description": "The recurrence id of the event",
            "format": "int32",
            "nullable": true
          },
          "registration_id": {
            "type": "integer",
            "description": "the registration id of the event",
            "format": "int32",
            "nullable": true
          },
          "rescheduled": {
            "type": "boolean",
            "description": "If the event is an athletic game, returns true if the game was rescheduled",
            "nullable": true
          },
          "reschedule_note": {
            "type": "string",
            "description": "If the event is an athletic game, the rescheduled note (usually the reason for the reschedule)",
            "nullable": true
          },
          "room_name": {
            "type": "string",
            "description": "The name of the room where the event is being held",
            "nullable": true
          },
          "scrimmage": {
            "type": "boolean",
            "description": "If the event is an athletic game, returns true if the game is a scrimmage",
            "nullable": true
          },
          "start_date": {
            "type": "string",
            "description": "The date the event starts",
            "format": "date-time",
            "nullable": true
          },
          "title": {
            "type": "string",
            "description": "The title of the event",
            "nullable": true
          },
          "tournament": {
            "type": "boolean",
            "description": "If the event is an athletic game, returns true if the game is part of a tournament",
            "nullable": true
          },
          "all_day": {
            "type": "boolean",
            "description": "Returns true if the event happens all day",
            "nullable": true
          },
          "total_days": {
            "type": "integer",
            "description": "Shows the total number of days the event spans",
            "format": "int32",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Calendar item"
      },
      "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/events/calendar?start_date={string}&end_date={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["start_date"] = "{string}";
            queryString["end_date"] = "{string}";
            var uri = "https://api.sky.blackbaud.com/school/v1/events/calendar?" + 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/events/calendar");

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

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

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'start_date' => '{string}',
    'end_date' => '{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
    'start_date': '{string}',
    'end_date': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/school/v1/events/calendar?%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
    'start_date': '{string}',
    'end_date': '{string}',
})

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

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