School

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

GET

Degrees by user ID (BETA)

Returns a collection of area of study objects for a user.

Requires the following role in the Education Management system:

  • Academic Group 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
user_id Property is required integer

user Id

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": [
    {
      "user_id": 12345,
      "degrees": [
        {
          "degree_type": 1,
          "credits_needed": 80.0,
          "institution_credits": 12.0,
          "area_of_study_type": "Major",
          "area_of_study_group_id": 14,
          "area_of_study_group": {
            "id": 6,
            "school_id": 123,
            "name": "Informatics",
            "display_name": "Informatics",
            "short_description": "",
            "long_description": "",
            "active": true,
            "status": "",
            "display_status": "",
            "created_by": "6ca45ee4-58eb-43b3-ae30-b01db74c0e1c",
            "modified_by": "6ca45ee4-58eb-43b3-ae30-b01db74c0e1c",
            "created": "2018-08-30T12:00:00Z",
            "modified": "2018-08-30T12:00:00Z"
          },
          "valid_from": "2018-08-30T12:00:00Z",
          "valid_to": "2018-08-30T12:00:00Z",
          "minimum_required_gpa": 4.0,
          "cip_prefix_code": "",
          "cip_suffix_code": "",
          "award_level": 1,
          "id": 6,
          "school_id": 123,
          "name": "Informatics",
          "display_name": "Informatics",
          "short_description": "",
          "long_description": "",
          "active": true,
          "status": "",
          "display_status": "",
          "created_by": "6ca45ee4-58eb-43b3-ae30-b01db74c0e1c",
          "modified_by": "6ca45ee4-58eb-43b3-ae30-b01db74c0e1c",
          "created": "2018-08-30T12:00:00Z",
          "modified": "2018-08-30T12:00:00Z",
          "process_order": 0
        }
      ],
      "areas_of_study": [
        {
          "area_of_study_type": "Major",
          "area_of_study_group_id": 14,
          "area_of_study_group": {
            "id": 6,
            "school_id": 123,
            "name": "Informatics",
            "display_name": "Informatics",
            "short_description": "",
            "long_description": "",
            "active": true,
            "status": "",
            "display_status": "",
            "created_by": "6ca45ee4-58eb-43b3-ae30-b01db74c0e1c",
            "modified_by": "6ca45ee4-58eb-43b3-ae30-b01db74c0e1c",
            "created": "2018-08-30T12:00:00Z",
            "modified": "2018-08-30T12:00:00Z"
          },
          "valid_from": "2018-08-30T12:00:00Z",
          "valid_to": "2018-08-30T12:00:00Z",
          "minimum_required_gpa": 4.0,
          "cip_prefix_code": "",
          "cip_suffix_code": "",
          "award_level": 1,
          "id": 6,
          "school_id": 123,
          "name": "Informatics",
          "display_name": "Informatics",
          "short_description": "",
          "long_description": "",
          "active": true,
          "status": "",
          "display_status": "",
          "created_by": "6ca45ee4-58eb-43b3-ae30-b01db74c0e1c",
          "modified_by": "6ca45ee4-58eb-43b3-ae30-b01db74c0e1c",
          "created": "2018-08-30T12:00:00Z",
          "modified": "2018-08-30T12:00:00Z",
          "process_order": 0
        }
      ],
      "user_area_of_study_groups": [
        {
          "id": 5,
          "school_id": 123,
          "created_by": "6ca45ee4-58eb-43b3-ae30-b01db74c0e1c",
          "modified_by": "6ca45ee4-58eb-43b3-ae30-b01db74c0e1c",
          "conferred_on": "2018-08-30T12:00:00Z",
          "completed_on": "2018-08-28T12:00:00Z",
          "created": "2018-08-30T12:00:00Z",
          "modified": "2018-08-30T12:00:00Z",
          "user_id": 12345,
          "bbid": "8d43da38-3898-453b-aa9c-b44a08d87c73",
          "primary_area_of_study_id": 5,
          "complete": true
        }
      ]
    }
  ]
}
{
  "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 for whom this data belongs",
            "format": "int32"
          },
          "degrees": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "degree_type": {
                  "type": "integer",
                  "description": "The degree type",
                  "format": "int32"
                },
                "credits_needed": {
                  "type": "number",
                  "description": "The total credits needed to complete the degree",
                  "format": "double"
                },
                "institution_credits": {
                  "type": "number",
                  "description": "The number of credits that must be from courses completed at this school.\r\n            <br />Subtract from the CreditsNeeded to determine the credits allowed to be transferred from another institution",
                  "format": "double"
                },
                "area_of_study_type": {
                  "type": "string",
                  "description": "The type of the area of study",
                  "nullable": true
                },
                "area_of_study_group_id": {
                  "type": "integer",
                  "description": "The id of the area of study group",
                  "format": "int32"
                },
                "area_of_study_group": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "description": "the Id of the group",
                      "format": "int32",
                      "nullable": true
                    },
                    "school_id": {
                      "type": "integer",
                      "description": "The Id of the school",
                      "format": "int32"
                    },
                    "name": {
                      "type": "string",
                      "description": "The name of the group",
                      "nullable": true
                    },
                    "display_name": {
                      "type": "string",
                      "description": "The display name of the group",
                      "nullable": true
                    },
                    "short_description": {
                      "type": "string",
                      "description": "The short description of the group",
                      "nullable": true
                    },
                    "long_description": {
                      "type": "string",
                      "description": "The long description of the group",
                      "nullable": true
                    },
                    "active": {
                      "type": "boolean",
                      "description": "Returns true if the group is active",
                      "nullable": true
                    },
                    "status": {
                      "type": "string",
                      "description": "The status of the group",
                      "nullable": true
                    },
                    "display_status": {
                      "type": "string",
                      "description": "The display status of the group",
                      "nullable": true
                    },
                    "created_by": {
                      "type": "string",
                      "description": "The BBID of the user who created the group",
                      "nullable": true
                    },
                    "modified_by": {
                      "type": "string",
                      "description": "The BBID of the user who last modified the group",
                      "nullable": true
                    },
                    "created": {
                      "type": "string",
                      "description": "The date the group was created",
                      "format": "date-time",
                      "nullable": true
                    },
                    "modified": {
                      "type": "string",
                      "description": "The date the group was last modified",
                      "format": "date-time",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false,
                  "description": ""
                },
                "valid_from": {
                  "type": "string",
                  "description": "The date the area of study becomes active",
                  "format": "date-time"
                },
                "valid_to": {
                  "type": "string",
                  "description": "The date the are of study becomes inactive",
                  "format": "date-time",
                  "nullable": true
                },
                "minimum_required_gpa": {
                  "type": "number",
                  "description": "If applicable the minimum gpa a user must carry to complete this area of study",
                  "format": "double",
                  "nullable": true
                },
                "cip_prefix_code": {
                  "type": "string",
                  "description": "The IPEDS CIP prefix code representing the \"category\" an area of study belongs to: for example 'Engineering'",
                  "nullable": true
                },
                "cip_suffix_code": {
                  "type": "string",
                  "description": "The IPEDS CIP suffix code representing a discrete componnent or course of an area of study: for example 'Polymers/Plastics Materials study'",
                  "nullable": true
                },
                "award_level": {
                  "type": "integer",
                  "description": "The designated award level for this area of study",
                  "format": "int32",
                  "nullable": true
                },
                "id": {
                  "type": "integer",
                  "description": "The Id of the area of study",
                  "format": "int32",
                  "nullable": true
                },
                "school_id": {
                  "type": "integer",
                  "description": "The Id of the school",
                  "format": "int32"
                },
                "name": {
                  "type": "string",
                  "description": "The name of the area of study",
                  "nullable": true
                },
                "display_name": {
                  "type": "string",
                  "description": "The display name of the area of study",
                  "nullable": true
                },
                "short_description": {
                  "type": "string",
                  "description": "The short description of the area of study",
                  "nullable": true
                },
                "long_description": {
                  "type": "string",
                  "description": "The long description of the area of study",
                  "nullable": true
                },
                "active": {
                  "type": "boolean",
                  "description": "Returns true if the are of study is active",
                  "nullable": true
                },
                "status": {
                  "type": "string",
                  "description": "The status of the area of study",
                  "nullable": true
                },
                "display_status": {
                  "type": "string",
                  "description": "The display status of the area of study",
                  "nullable": true
                },
                "created_by": {
                  "type": "string",
                  "description": "The BBID of the user who created the area of study",
                  "nullable": true
                },
                "modified_by": {
                  "type": "string",
                  "description": "The BBID of the user who last modified the area of study",
                  "nullable": true
                },
                "created": {
                  "type": "string",
                  "description": "The date the area of study was created",
                  "format": "date-time",
                  "nullable": true
                },
                "modified": {
                  "type": "string",
                  "description": "The date the area of study was last modified",
                  "format": "date-time",
                  "nullable": true
                },
                "process_order": {
                  "type": "integer",
                  "description": "The order in which this item is processed for degree completion or auditing",
                  "format": "int32",
                  "nullable": true
                }
              },
              "additionalProperties": false,
              "description": ""
            },
            "description": "The list of degrees for the user",
            "nullable": true
          },
          "areas_of_study": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "area_of_study_type": {
                  "type": "string",
                  "description": "The type of the area of study",
                  "nullable": true
                },
                "area_of_study_group_id": {
                  "type": "integer",
                  "description": "The id of the area of study group",
                  "format": "int32"
                },
                "area_of_study_group": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "description": "the Id of the group",
                      "format": "int32",
                      "nullable": true
                    },
                    "school_id": {
                      "type": "integer",
                      "description": "The Id of the school",
                      "format": "int32"
                    },
                    "name": {
                      "type": "string",
                      "description": "The name of the group",
                      "nullable": true
                    },
                    "display_name": {
                      "type": "string",
                      "description": "The display name of the group",
                      "nullable": true
                    },
                    "short_description": {
                      "type": "string",
                      "description": "The short description of the group",
                      "nullable": true
                    },
                    "long_description": {
                      "type": "string",
                      "description": "The long description of the group",
                      "nullable": true
                    },
                    "active": {
                      "type": "boolean",
                      "description": "Returns true if the group is active",
                      "nullable": true
                    },
                    "status": {
                      "type": "string",
                      "description": "The status of the group",
                      "nullable": true
                    },
                    "display_status": {
                      "type": "string",
                      "description": "The display status of the group",
                      "nullable": true
                    },
                    "created_by": {
                      "type": "string",
                      "description": "The BBID of the user who created the group",
                      "nullable": true
                    },
                    "modified_by": {
                      "type": "string",
                      "description": "The BBID of the user who last modified the group",
                      "nullable": true
                    },
                    "created": {
                      "type": "string",
                      "description": "The date the group was created",
                      "format": "date-time",
                      "nullable": true
                    },
                    "modified": {
                      "type": "string",
                      "description": "The date the group was last modified",
                      "format": "date-time",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false,
                  "description": ""
                },
                "valid_from": {
                  "type": "string",
                  "description": "The date the area of study becomes active",
                  "format": "date-time"
                },
                "valid_to": {
                  "type": "string",
                  "description": "The date the are of study becomes inactive",
                  "format": "date-time",
                  "nullable": true
                },
                "minimum_required_gpa": {
                  "type": "number",
                  "description": "If applicable the minimum gpa a user must carry to complete this area of study",
                  "format": "double",
                  "nullable": true
                },
                "cip_prefix_code": {
                  "type": "string",
                  "description": "The IPEDS CIP prefix code representing the \"category\" an area of study belongs to: for example 'Engineering'",
                  "nullable": true
                },
                "cip_suffix_code": {
                  "type": "string",
                  "description": "The IPEDS CIP suffix code representing a discrete componnent or course of an area of study: for example 'Polymers/Plastics Materials study'",
                  "nullable": true
                },
                "award_level": {
                  "type": "integer",
                  "description": "The designated award level for this area of study",
                  "format": "int32",
                  "nullable": true
                },
                "id": {
                  "type": "integer",
                  "description": "The Id of the area of study",
                  "format": "int32",
                  "nullable": true
                },
                "school_id": {
                  "type": "integer",
                  "description": "The Id of the school",
                  "format": "int32"
                },
                "name": {
                  "type": "string",
                  "description": "The name of the area of study",
                  "nullable": true
                },
                "display_name": {
                  "type": "string",
                  "description": "The display name of the area of study",
                  "nullable": true
                },
                "short_description": {
                  "type": "string",
                  "description": "The short description of the area of study",
                  "nullable": true
                },
                "long_description": {
                  "type": "string",
                  "description": "The long description of the area of study",
                  "nullable": true
                },
                "active": {
                  "type": "boolean",
                  "description": "Returns true if the are of study is active",
                  "nullable": true
                },
                "status": {
                  "type": "string",
                  "description": "The status of the area of study",
                  "nullable": true
                },
                "display_status": {
                  "type": "string",
                  "description": "The display status of the area of study",
                  "nullable": true
                },
                "created_by": {
                  "type": "string",
                  "description": "The BBID of the user who created the area of study",
                  "nullable": true
                },
                "modified_by": {
                  "type": "string",
                  "description": "The BBID of the user who last modified the area of study",
                  "nullable": true
                },
                "created": {
                  "type": "string",
                  "description": "The date the area of study was created",
                  "format": "date-time",
                  "nullable": true
                },
                "modified": {
                  "type": "string",
                  "description": "The date the area of study was last modified",
                  "format": "date-time",
                  "nullable": true
                },
                "process_order": {
                  "type": "integer",
                  "description": "The order in which this item is processed for degree completion or auditing",
                  "format": "int32",
                  "nullable": true
                }
              },
              "additionalProperties": false,
              "description": ""
            },
            "description": "The list of area of study for the user",
            "nullable": true
          },
          "user_area_of_study_groups": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer",
                  "description": "the Id of the user area of study group",
                  "format": "int32",
                  "nullable": true
                },
                "school_id": {
                  "type": "integer",
                  "description": "the Id of the school",
                  "format": "int32"
                },
                "created_by": {
                  "type": "string",
                  "description": "The BBID of the user who created the user area of study group",
                  "nullable": true
                },
                "modified_by": {
                  "type": "string",
                  "description": "The BBID of the user who last modified the user area of study group",
                  "nullable": true
                },
                "conferred_on": {
                  "type": "string",
                  "description": "The date the institution gave the degree to the user",
                  "format": "date-time",
                  "nullable": true
                },
                "completed_on": {
                  "type": "string",
                  "description": "The date the degree was completed by the user",
                  "format": "date-time",
                  "nullable": true
                },
                "created": {
                  "type": "string",
                  "description": "The date the user area of study group was created",
                  "format": "date-time",
                  "nullable": true
                },
                "modified": {
                  "type": "string",
                  "description": "The date the user area of study group was last modified",
                  "format": "date-time",
                  "nullable": true
                },
                "user_id": {
                  "type": "integer",
                  "description": "The user Id tied to this user area of study group",
                  "format": "int32"
                },
                "bbid": {
                  "type": "string",
                  "description": "The BBID of the user tied to this user area of study group",
                  "nullable": true
                },
                "primary_area_of_study_id": {
                  "type": "integer",
                  "description": "The primary area of study (based on type, either degree or diploma)",
                  "format": "int32"
                },
                "complete": {
                  "type": "boolean",
                  "description": "Returns true if the area of study group is complete",
                  "nullable": true
                }
              },
              "additionalProperties": false,
              "description": ""
            },
            "description": "The users are of study groups",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": ""
      },
      "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/degrees/{user_id}"
-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}");

            var uri = "https://api.sky.blackbaud.com/school/v1/degrees/{user_id}?" + 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/degrees/{user_id}");


            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
        };

        $.ajax({
            url: "https://api.sky.blackbaud.com/school/v1/degrees/{user_id}?" + $.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/degrees/{user_id}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];

    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/degrees/{user_id}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$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({
})

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

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

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!