School

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

GET

Admissions candidates

Returns a collection of admissions candidates.

Requires the following role in the Education Management system:

  • Admissions Manager
  • Platform Manager
  • SKY API Data Sync

Try it

Request URL

Request parameters

Parameter Required Type Description
school_year_id integer

The year Id for which to return results. Corresponds to id in the Year list. Default is current year.

status_ids string

One or more comma delimited status Id(s) to filter results on. Default is no status Id filter.

modified_date string

The date last modified to filter results to on or after. Use ISO-8601 date format: 2003-04-21. Default is no modified date filter

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,
      "first_name": "James",
      "last_name": "Dean",
      "middle_name": "Byron",
      "prefix": "",
      "suffix": "",
      "nickname": "Jimmy",
      "role": "Candidate",
      "role_id": 4543,
      "current_status": "Applied",
      "status_id": 646,
      "school_decision": "Accepted",
      "school_decision_type": 6,
      "candidate_decision": "Enrolling",
      "candidate_decision_type": 14,
      "entering_year": "2020 - 2021",
      "entering_year_id": 4520144,
      "entering_grade": "9",
      "entering_grade_id": 544,
      "email": "JimmyJim@DeansCourt.com",
      "comment": "Enjoys Chess and Acting",
      "parent1_email": "Mom@DeansCourt.com",
      "parent2_email": "Dad@DeansCourt.com",
      "international": false,
      "school_program": "High School Program",
      "gender": "M",
      "ethnicity": "Caucasian",
      "boarding_or_day": "B",
      "financial_aid": true,
      "admissions_staff_id": 54321,
      "admissions_staff": "John Smith",
      "inquiry_source": "Open House",
      "inquiry_source_id": 3,
      "referral_type": "Alum",
      "referral_type_id": 1,
      "has_iep": false,
      "has_504": true,
      "created_by": "789789",
      "created": "2022-01-01T23:13:33Z",
      "modified_by": "789789",
      "modified": "2022-01-01T23:13:33Z",
      "preferred_name": "Jimmy"
    }
  ]
}
{
  "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": "Unique Identifer for this candidate",
            "format": "int32",
            "nullable": true
          },
          "first_name": {
            "type": "string",
            "description": "Candidates first name",
            "nullable": true
          },
          "last_name": {
            "type": "string",
            "description": "Candidates last name",
            "nullable": true
          },
          "middle_name": {
            "type": "string",
            "description": "Candidates middle name",
            "nullable": true
          },
          "prefix": {
            "type": "string",
            "description": "Prefix",
            "nullable": true
          },
          "suffix": {
            "type": "string",
            "description": "Suffix",
            "nullable": true
          },
          "nickname": {
            "type": "string",
            "description": "Candidates nick name (if available)",
            "nullable": true
          },
          "role": {
            "type": "string",
            "description": "Role for this candidate.",
            "nullable": true
          },
          "role_id": {
            "type": "integer",
            "description": "Identifier for thier role",
            "format": "int32",
            "nullable": true
          },
          "current_status": {
            "type": "string",
            "description": "Text representation of their current enrollment status",
            "nullable": true
          },
          "status_id": {
            "type": "integer",
            "description": "Identifier for their enrollment status",
            "format": "int32",
            "nullable": true
          },
          "school_decision": {
            "type": "string",
            "description": "Text representation of the schools decision",
            "nullable": true
          },
          "school_decision_type": {
            "type": "integer",
            "description": "Identifier for the schools decision",
            "format": "int32",
            "nullable": true
          },
          "school_decision_date": {
            "type": "string",
            "description": "",
            "format": "date-time",
            "nullable": true
          },
          "candidate_decision": {
            "type": "string",
            "description": "Text representation of the candidates decision",
            "nullable": true
          },
          "candidate_decision_type": {
            "type": "integer",
            "description": "Identifier for the candidates decision",
            "format": "int32",
            "nullable": true
          },
          "candidate_decision_date": {
            "type": "string",
            "description": "",
            "format": "date-time",
            "nullable": true
          },
          "entering_year": {
            "type": "string",
            "description": "Text representation of the school year the candidate will be joining",
            "nullable": true
          },
          "entering_year_id": {
            "type": "integer",
            "description": "Identifier for the school year the candidate will be joining",
            "format": "int32",
            "nullable": true
          },
          "entering_grade": {
            "type": "string",
            "description": "Text representation of the grade candidate will be joining",
            "nullable": true
          },
          "entering_grade_id": {
            "type": "integer",
            "description": "Identifier for the grade candidate will be joining",
            "format": "int32",
            "nullable": true
          },
          "email": {
            "type": "string",
            "description": "Candidates email",
            "nullable": true
          },
          "comment": {
            "type": "string",
            "description": "Comments",
            "nullable": true
          },
          "parent1_email": {
            "type": "string",
            "description": "1st Email of candidates parent",
            "nullable": true
          },
          "parent2_email": {
            "type": "string",
            "description": "2nd email of candidates parent",
            "nullable": true
          },
          "international": {
            "type": "boolean",
            "description": "",
            "nullable": true
          },
          "school_program": {
            "type": "string",
            "description": "",
            "nullable": true
          },
          "gender": {
            "type": "string",
            "description": "",
            "nullable": true
          },
          "ethnicity": {
            "type": "string",
            "description": "",
            "nullable": true
          },
          "boarding_or_day": {
            "type": "string",
            "description": "",
            "nullable": true
          },
          "financial_aid": {
            "type": "boolean",
            "description": "",
            "nullable": true
          },
          "admissions_staff_id": {
            "type": "integer",
            "description": "",
            "format": "int32",
            "nullable": true
          },
          "admissions_staff": {
            "type": "string",
            "description": "",
            "nullable": true
          },
          "inquiry_source": {
            "type": "string",
            "description": "",
            "nullable": true
          },
          "inquiry_source_id": {
            "type": "integer",
            "description": "",
            "format": "int32",
            "nullable": true
          },
          "referral_type": {
            "type": "string",
            "description": "",
            "nullable": true
          },
          "referral_type_id": {
            "type": "integer",
            "description": "",
            "format": "int32",
            "nullable": true
          },
          "has_iep": {
            "type": "boolean",
            "description": "",
            "nullable": true
          },
          "has_504": {
            "type": "boolean",
            "description": "",
            "nullable": true
          },
          "created_by": {
            "type": "string",
            "description": "",
            "nullable": true
          },
          "created": {
            "type": "string",
            "description": "",
            "format": "date-time",
            "nullable": true
          },
          "modified_by": {
            "type": "string",
            "description": "",
            "nullable": true
          },
          "modified": {
            "type": "string",
            "description": "",
            "format": "date-time",
            "nullable": true
          },
          "preferred_name": {
            "type": "string",
            "description": "",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Candidate Read"
      },
      "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/admissions/candidates?school_year_id={integer}&status_ids={string}&modified_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["school_year_id"] = "{integer}";
            queryString["status_ids"] = "{string}";
            queryString["modified_date"] = "{string}";
            var uri = "https://api.sky.blackbaud.com/school/v1/admissions/candidates?" + 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/admissions/candidates");

            builder.setParameter("school_year_id", "{integer}");
            builder.setParameter("status_ids", "{string}");
            builder.setParameter("modified_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
            "school_year_id": "{integer}",
            "status_ids": "{string}",
            "modified_date": "{string}",
        };

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

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'school_year_id' => '{integer}',
    'status_ids' => '{string}',
    'modified_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
    'school_year_id': '{integer}',
    'status_ids': '{string}',
    'modified_date': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/school/v1/admissions/candidates?%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
    'school_year_id': '{integer}',
    'status_ids': '{string}',
    'modified_date': '{string}',
})

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

query = URI.encode_www_form({
    # Request parameters
    'school_year_id' => '{integer}',
    'status_ids' => '{string}',
    'modified_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!