Constituent

This API manages constituent information and related entities such as addresses, phones, emails, and notes.

GET

Education list (Single constituent)

Returns a list of education items for a constituent.

Try it

Request URL

Request parameters

Parameter Required Type Description
constituent_id Property is required string

The immutable system record ID of the constituent to retrieve the education items for.

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

Returned when the operation succeeds. The response body contains a collection of education entities. UK education record fields are conditionally populated based on the regional configuration of the database.

{
  "count": 2,
  "value": [
    {
      "id": "12",
      "campus": "Greenville",
      "class_of": "2009",
      "constituent_id": "280",
      "date_entered": {
        "m": 8,
        "y": 2004
      },
      "date_graduated": {
        "d": 3,
        "m": 6,
        "y": 2009
      },
      "degree": "MD",
      "gpa": 3.8,
      "known_name": "Robby",
      "majors": [
        "Computer Science"
      ],
      "minors": [
        "History"
      ],
      "primary": true,
      "school": "University of South Carolina",
      "social_organization": "Order of Omega",
      "status": "Graduated",
      "type": "Four Year College"
    },
    {
      "id": "13",
      "campus": "Croatia",
      "class_of": "2005",
      "constituent_id": "280",
      "date_entered": {
        "m": 8,
        "y": 2001
      },
      "date_graduated": {
        "m": 6,
        "y": 2005
      },
      "degree": "BS",
      "gpa": 4,
      "known_name": "Bert",
      "majors": [
        "Computer Science"
      ],
      "minors": [
        "History"
      ],
      "primary": false,
      "school": "Rochester Institute of Technology",
      "social_organization": "Kappa Delta Rho",
      "status": "Graduated",
      "type": "Four Year College"
    }
  ]
}
{
  "description": "Fetching data all at once quickly becomes unmanageable. The collection entity helps by returning paginated chunks of large data sets. This entity includes helpful metadata and properties to paginate and iterate through the data.",
  "type": "object",
  "properties": {
    "count": {
      "format": "int32",
      "description": "The number of items available for retrieval into the collection after applying any request parameters. The <b>limit</b> and <b>offset</b> parameters do not affect the <b>count</b>, but to facilitate paging, they may affect the number of items in the <b>value</b> result set.",
      "type": "integer"
    },
    "next_link": {
      "description": "For paginated responses, the URI for the next page of results.",
      "type": "string"
    },
    "value": {
      "description": "The set of items included in the response. This may be a subset of the items in the collection.",
      "type": "array",
      "items": {
        "description": "A constituent’s education history provides important insight into who they are and often helps determine which causes the constituent will invest time and money into.",
        "type": "object",
        "properties": {
          "id": {
            "description": "The immutable system record ID of the education.",
            "type": "string"
          },
          "campus": {
            "description": "The campus.",
            "type": "string"
          },
          "class_of": {
            "description": "The year the constituent graduated.",
            "type": "string"
          },
          "class_of_degree": {
            "description": "The class of degree. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListEducationDegreeClasses\"><b>Class of Degree</b></a> table. For the UK only.",
            "type": "string"
          },
          "constituent_id": {
            "description": "The immutable system record ID of the constituent associated with the education.",
            "type": "string"
          },
          "date_added": {
            "format": "date-time",
            "description": "The date when the education was created. Includes an offset from UTC in <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43-04:00</i>.",
            "type": "string",
            "x-supports-datetime-offset": true
          },
          "date_entered": {
            "description": "The first date of attendance.",
            "type": "object",
            "properties": {
              "d": {
                "format": "int32",
                "description": "The day in the fuzzy date.",
                "type": "integer"
              },
              "m": {
                "format": "int32",
                "description": "The month in the fuzzy date.",
                "type": "integer"
              },
              "y": {
                "format": "int32",
                "description": "The year in the fuzzy date.",
                "type": "integer"
              }
            },
            "x-display-name": "Fuzzy date",
            "x-display-id": "FuzzyDate"
          },
          "date_graduated": {
            "description": "The graduation date.",
            "type": "object",
            "properties": {
              "d": {
                "format": "int32",
                "description": "The day in the fuzzy date.",
                "type": "integer"
              },
              "m": {
                "format": "int32",
                "description": "The month in the fuzzy date.",
                "type": "integer"
              },
              "y": {
                "format": "int32",
                "description": "The year in the fuzzy date.",
                "type": "integer"
              }
            },
            "x-display-name": "Fuzzy date",
            "x-display-id": "FuzzyDate"
          },
          "date_left": {
            "description": "The last date of attendance.",
            "type": "object",
            "properties": {
              "d": {
                "format": "int32",
                "description": "The day in the fuzzy date.",
                "type": "integer"
              },
              "m": {
                "format": "int32",
                "description": "The month in the fuzzy date.",
                "type": "integer"
              },
              "y": {
                "format": "int32",
                "description": "The year in the fuzzy date.",
                "type": "integer"
              }
            },
            "x-display-name": "Fuzzy date",
            "x-display-id": "FuzzyDate"
          },
          "date_modified": {
            "format": "date-time",
            "description": "The date when the education was last modified. Includes an offset from UTC in <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43-04:00</i>.",
            "type": "string",
            "x-supports-datetime-offset": true
          },
          "degree": {
            "description": "The degree received. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListEducationDegrees\"><b>Degrees</b></a> table.",
            "type": "string"
          },
          "department": {
            "description": "The name of the education department. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListEducationDepartments\"><b>Departments</b></a> table. For the UK only.",
            "type": "string"
          },
          "faculty": {
            "description": "The name of the faculty. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListEducationFaculties\"><b>Faculties</b></a> table. For the UK only.",
            "type": "string"
          },
          "gpa": {
            "format": "double",
            "description": "The grade point average.",
            "type": "number"
          },
          "known_name": {
            "description": "The known name.",
            "type": "string"
          },
          "majors": {
            "description": "The major courses of study. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListEducationSubjects\"><b>Major/Minor</b></a> table.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "minors": {
            "description": "The minor courses of study. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListEducationSubjects\"><b>Major/Minor</b></a> table.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "primary": {
            "description": "Indicates whether this is the constituent's primary school association.",
            "type": "boolean"
          },
          "registration_number": {
            "description": "The registration number. For the UK only.",
            "type": "string"
          },
          "school": {
            "description": "The school name. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListEducationSchools\"><b>Schools</b></a> table. For the UK, this property is for the establishment name, and available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListEducationSchools\"><b>Establishments</b></a> table.",
            "type": "string"
          },
          "social_organization": {
            "description": "The social organization.",
            "type": "string"
          },
          "status": {
            "description": "The status of the education. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListEducationStatuses\"><b>Education Status</b></a> table.",
            "type": "string"
          },
          "subject_of_study": {
            "description": "The subject of study. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListEducationSubjects\"><b>Subject of Study</b></a> table. For the UK only.",
            "type": "string"
          },
          "type": {
            "description": "The type of education. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListEducationTypes\"><b>School Types</b></a> table.",
            "type": "string"
          }
        },
        "x-display-name": "Education",
        "x-display-id": "Education"
      }
    }
  },
  "x-hidden": true,
  "x-base-type": "#/definitions/ApiCollection"
}

Response 400 Bad Request

Returned when the specified constituent ID in the request URL is not in the appropriate format.

Response 403 Forbidden

Returned when the user does not have permission to view the education items.

Response 404 Not Found

Returned when the specified constituent is not found.

Code samples

@ECHO OFF

curl -v -X GET "https://api.sky.blackbaud.com/constituent/v1/constituents/{constituent_id}/educations"
-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/constituent/v1/constituents/{constituent_id}/educations?" + 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/constituent/v1/constituents/{constituent_id}/educations");


            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/constituent/v1/constituents/{constituent_id}/educations?" + $.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/constituent/v1/constituents/{constituent_id}/educations";
    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/constituent/v1/constituents/{constituent_id}/educations');
$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", "/constituent/v1/constituents/{constituent_id}/educations?%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", "/constituent/v1/constituents/{constituent_id}/educations?%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/constituent/v1/constituents/{constituent_id}/educations')

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!