School

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

GET

Schedules meetings (BETA)

Returns a list of section meetings for a given date. When end_date is supplied a range of meetings between the given dates is returned.
offering_types can take a single or multiple values as a comma delimited string of integers, defaults to 1
end_date cannot be more than 30 days past the start_date. Default date range is 30 days.

  • Academics: 1
  • Activities: 2
  • Advisory: 3
  • Athletics: 9
Requires at least one of the following roles in the Education Management system:

  • Academics Group Manager
  • Advisory Group Manager
  • Platform Manager
  • Activity Group Manager
  • Athletic Group Manager
  • Scheduling Manager

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 Property is required string

Use ISO-8601 date format: 2022-04-01.

end_date string

Use ISO-8601 date format: 2022-04-08.

offering_types string

Comma delimited list of integer values above. Defaults to 1.

section_ids string

Comma delimited list of integer values for the section identifiers to return. By default the route returns all sections.

last_modified string

Filters meetings to sections that were modified on or after the date provided.
Use ISO-8601 date format: 2022-04-01.

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": [
    {
      "section_id": 1,
      "section_identifier": "Identifier",
      "course_title": "Course Title",
      "group_name": "Group Name",
      "block_id": 3,
      "block_name": "Block Name",
      "room_id": 1,
      "room_name": "Room Name",
      "room_number": 1,
      "room_capacity": 20,
      "room_code": "Code",
      "faculty_user_id": 1,
      "faculty_name": "Stark, Tony",
      "faculty_firstname": "Tony",
      "faculty_lastname": "Stark",
      "start_time": "1970-01-01T13:00:00Z",
      "end_time": "1970-01-01T14:00:00Z",
      "meeting_date": "2022-02-02T00:00:00Z",
      "attendance_required": true,
      "attendance_taken": false,
      "num_absent": 0,
      "attendance_id": 12,
      "level_number": 1,
      "offering_type": {
        "id": 1,
        "description": "Academics"
      },
      "created_date": "1970-01-01T14:00:00Z",
      "modified_date": "1970-01-01T14:00:00Z",
      "last_modified_user_id": 123456,
      "teachers": [
        {
          "id": 1010101,
          "head": true,
          "name": "Tony Stark",
          "firstname": "Anthony",
          "lastname": "Stark",
          "preferred_name": "Tony",
          "formatted_name": "Stark, Tony",
          "email": "ironman@avengers.com",
          "cell_phone": "555-555-5555"
        },
        {
          "id": 1010102,
          "head": false,
          "name": "James Rodes",
          "firstname": "James",
          "lastname": "Rodes",
          "preferred_name": "",
          "formatted_name": "Rodes, James",
          "email": "warmachine@avengers.com",
          "cell_phone": "555-555-5551"
        }
      ]
    }
  ]
}
{
  "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": {
          "section_id": {
            "type": "integer",
            "description": "The id of the section",
            "format": "int32"
          },
          "section_identifier": {
            "type": "string",
            "description": "The section identifier",
            "nullable": true
          },
          "course_title": {
            "type": "string",
            "description": "The title of the course",
            "nullable": true
          },
          "group_name": {
            "type": "string",
            "description": "The auto generated name of the group",
            "nullable": true
          },
          "block_id": {
            "type": "integer",
            "description": "The id of the block",
            "format": "int32"
          },
          "block_name": {
            "type": "string",
            "description": "The name of the block",
            "nullable": true
          },
          "room_id": {
            "type": "integer",
            "description": "The id of the room where the meeting takes place",
            "format": "int32"
          },
          "room_name": {
            "type": "string",
            "description": "The name of the room where the meeting takes place",
            "nullable": true
          },
          "room_number": {
            "type": "integer",
            "description": "The room number where the meeting takes place",
            "format": "int32"
          },
          "room_capacity": {
            "type": "integer",
            "description": "The room capacity",
            "format": "int32"
          },
          "room_code": {
            "type": "string",
            "description": "The room code",
            "nullable": true
          },
          "faculty_user_id": {
            "type": "integer",
            "description": "The user id of the faculty member",
            "format": "int32"
          },
          "faculty_name": {
            "type": "string",
            "description": "The combined name of the head faculty member",
            "nullable": true
          },
          "faculty_firstname": {
            "type": "string",
            "description": "The faculty member's first name",
            "nullable": true
          },
          "faculty_lastname": {
            "type": "string",
            "description": "The faculty member's last name",
            "nullable": true
          },
          "start_time": {
            "type": "string",
            "description": "The start time of the meeting",
            "format": "date-time"
          },
          "end_time": {
            "type": "string",
            "description": "The end time of the meeting",
            "format": "date-time"
          },
          "meeting_date": {
            "type": "string",
            "description": "The date the meeting takes place",
            "format": "date-time"
          },
          "attendance_required": {
            "type": "boolean",
            "description": "Returns true if attendance is required to be taken for this meeting"
          },
          "attendance_taken": {
            "type": "boolean",
            "description": "Return true if attendance was taken"
          },
          "num_absent": {
            "type": "integer",
            "description": "The number of absent students for this meeting",
            "format": "int32"
          },
          "attendance_id": {
            "type": "integer",
            "description": "the id of the attendance record",
            "format": "int32"
          },
          "level_number": {
            "type": "integer",
            "description": "The level number the meeting belongs to",
            "format": "int32"
          },
          "offering_type": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "description": "The ID of an offering type",
                "format": "int32"
              },
              "description": {
                "type": "string",
                "description": "The description of an offering type",
                "nullable": true
              }
            },
            "additionalProperties": false,
            "description": "OfferingType Model"
          },
          "created_date": {
            "type": "string",
            "description": "The date the section was created",
            "format": "date-time"
          },
          "modified_date": {
            "type": "string",
            "description": "The date the section was last modified",
            "format": "date-time"
          },
          "last_modified_user_id": {
            "type": "integer",
            "description": "The identifier of the user that last modified the section",
            "format": "int32"
          },
          "teachers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer",
                  "description": "The user ID for the teacher",
                  "format": "int32",
                  "nullable": true
                },
                "head": {
                  "type": "boolean",
                  "description": "The head teacher indicator",
                  "nullable": true
                },
                "name": {
                  "type": "string",
                  "description": "The firstname and lastname of the teacher",
                  "nullable": true
                },
                "firstname": {
                  "type": "string",
                  "description": "The first name of the teacher",
                  "nullable": true
                },
                "lastname": {
                  "type": "string",
                  "description": "The last name of the teacher",
                  "nullable": true
                },
                "preferred_name": {
                  "type": "string",
                  "description": "The teachers preferred name",
                  "nullable": true
                },
                "formatted_name": {
                  "type": "string",
                  "description": "The formatted name of the teacher.  If the teacher has a preferred name, it is used in place of the first name.",
                  "nullable": true
                },
                "email": {
                  "type": "string",
                  "description": "The teacher's email address",
                  "nullable": true
                },
                "cell_phone": {
                  "type": "string",
                  "description": "The teacher's cellular phone",
                  "nullable": true
                }
              },
              "additionalProperties": false,
              "description": "Academic Teacher Model"
            },
            "description": "The list of teachers for the meeting",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Meeting"
      },
      "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/schedules/meetings?start_date={start_date}?end_date={string}&offering_types=1&section_ids={string}&last_modified={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["end_date"] = "{string}";
            queryString["offering_types"] = "1";
            queryString["section_ids"] = "{string}";
            queryString["last_modified"] = "{string}";
            var uri = "https://api.sky.blackbaud.com/school/v1/schedules/meetings?start_date={start_date}&" + 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/schedules/meetings?start_date={start_date}");

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

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

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

$request->setHeader($headers);

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

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

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

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