School

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

GET

Attendance record

Returns a collection of student attendance records for the specified day.

Requires the following role in the Education Management system:

  • Attendance Manager

Try it

Request URL

Request parameters

Parameter Required Type Description
level_id Property is required integer

The ID of the school level to retrieve attendance records.
day Property is required string

The date to return attendance for.
offering_type Property is required integer

The offering type to retrieve records for.
excuse_type integer

Filters results to a specific excuse type.

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": 2,
  "value": [
    {
      "id": 3520290,
      "attendance_of_record": true,
      "attendance_type": false,
      "block_name": "A",
      "comment": "Field Trip",
      "date": "2018-08-30T12:00:00Z",
      "excuse_category_description": "Field Trip Category",
      "excuse_category_id": 0,
      "excuse_description": "Field Trip",
      "excuse_type_id": 396,
      "excused": 1,
      "grad_year": "2013",
      "grade": "12",
      "grade_level_sort": 1200,
      "group_name": "Sculture - 1 (A)",
      "photo_file_name": "thumb_user2845263_109153.jpg",
      "section": "1",
      "section_id": 1300129,
      "student_name": "Arai, Emilia '13",
      "student_user_id": 2845263,
      "teacher_name": "Viens, George"
    },
    {
      "id": 3520291,
      "attendance_of_record": true,
      "attendance_type": false,
      "block_name": "E",
      "comment": "Field Trip",
      "date": "2018-08-30T12:00:00Z",
      "excuse_category_description": "Field Trip Category",
      "excuse_category_id": 0,
      "excuse_description": "Field Trip",
      "excuse_type_id": 396,
      "excused": 1,
      "grad_year": "2013",
      "grade": "11",
      "grade_level_sort": 1100,
      "group_name": "Latin III - 1 (E)",
      "photo_file_name": "thumb_user2845263_109162.jpg",
      "section": "1",
      "section_id": 1300129,
      "student_name": "Smith, Ian",
      "student_user_id": 2845263,
      "teacher_name": "Sapsin, Flora"
    }
  ]
}
{
  "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 attendance",
            "format": "int64"
          },
          "attendance_of_record": {
            "type": "boolean",
            "description": "Attendance of record"
          },
          "attendance_type": {
            "type": "boolean",
            "description": "The type of the attendance"
          },
          "block_name": {
            "type": "string",
            "description": "The name of the block",
            "nullable": true
          },
          "comment": {
            "type": "string",
            "description": "Attendance record comment",
            "nullable": true
          },
          "date": {
            "type": "string",
            "description": "The date of the attendance record. Uses <a href=\"https://tools.ietf.org/html/rfc3339\" target=\"_blank\">ISO-8601</a> (24H) format: 2003-04-21T10:29:43",
            "format": "date-time",
            "nullable": true
          },
          "excuse_category_description": {
            "type": "string",
            "description": "The category description of the excuse",
            "nullable": true
          },
          "excuse_category_id": {
            "type": "integer",
            "description": "The category of the excuse",
            "format": "int32"
          },
          "excuse_description": {
            "type": "string",
            "description": "The description of the excuse",
            "nullable": true
          },
          "excuse_type_id": {
            "type": "integer",
            "description": "The type of the excuse",
            "format": "int32"
          },
          "excused": {
            "type": "integer",
            "description": "Whether the absence was excused",
            "format": "int32"
          },
          "grad_year": {
            "type": "string",
            "description": "The graduation year of the student",
            "nullable": true
          },
          "grade": {
            "type": "string",
            "description": "The grade of the student",
            "nullable": true
          },
          "grade_level_sort": {
            "type": "integer",
            "description": "Grade level sort order",
            "format": "int32"
          },
          "group_name": {
            "type": "string",
            "description": "The group name",
            "nullable": true
          },
          "photo_file_name": {
            "type": "string",
            "description": "The phone file name",
            "nullable": true
          },
          "section": {
            "type": "string",
            "description": "The section",
            "nullable": true
          },
          "section_id": {
            "type": "integer",
            "description": "The ID of the section",
            "format": "int32"
          },
          "student_name": {
            "type": "string",
            "description": "The name of the student",
            "nullable": true
          },
          "student_user_id": {
            "type": "integer",
            "description": "The student user ID",
            "format": "int32"
          },
          "teacher_name": {
            "type": "string",
            "description": "The name of the teacher",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Attendance 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/attendance?level_id={level_id}&day={day}&offering_type={offering_type}?excuse_type={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["excuse_type"] = "{integer}";
            var uri = "https://api.sky.blackbaud.com/school/v1/attendance?level_id={level_id}&day={day}&offering_type={offering_type}&" + 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/attendance?level_id={level_id}&day={day}&offering_type={offering_type}");

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

        $.ajax({
            url: "https://api.sky.blackbaud.com/school/v1/attendance?level_id={level_id}&day={day}&offering_type={offering_type}&" + $.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/attendance?level_id={level_id}&day={day}&offering_type={offering_type}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"excuse_type={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/attendance?level_id={level_id}&day={day}&offering_type={offering_type}');
$url = $request->getUrl();

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

$request->setHeader($headers);

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

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/school/v1/attendance?level_id={level_id}&day={day}&offering_type={offering_type}&%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
    'excuse_type': '{integer}',
})

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

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

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!