School
This API is used to provide access to school information such as users, academics, admissions, athletics, content, lists, and general school info.
GET
Users emergency contacts by user ID
Returns a collection of a emergency contacts for the specified user_id.
Requires at least one of the following roles in the Education Management system:
- SKY API Data Sync
Request URL
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| user_id | Property is required | integer | The ID of the user. |
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. |
Response 200 OK
Success
{
"id": 5,
"email_contact_list": [
{
"id": 1,
"automated_email": "Emergency Only",
"contact_id": 1,
"email": "example@aol.com",
"first_name": "John",
"last_name": "Smith",
"relationship": "Child",
"relationship_id": 1,
"relationship_user_id": 11111,
"sort_order": 1,
"user_contact_id": 0
}
],
"phone_contact_list": [
{
"id": 1,
"call_dialer": "Emergency Only",
"contact_id": 1,
"first_name": "John",
"last_name": "Smith",
"phone_id": 1,
"phone_index_id": 1,
"phone_number": "555-555-5555",
"phone_type": "Home",
"relationship": "Child",
"relationship_id": 1,
"relationship_user_id": 11111,
"sort_order": 1,
"user_contact_id": 0
}
]
}{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "User ID",
"format": "int32"
},
"email_contact_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Emergency contact email ID",
"format": "int32"
},
"automated_email": {
"type": "string",
"description": "Automated email type",
"nullable": true
},
"contact_id": {
"type": "integer",
"description": "Contact ID",
"format": "int32"
},
"email": {
"type": "string",
"description": "The email address of a user",
"nullable": true
},
"first_name": {
"type": "string",
"description": "The first name of the emergency contact",
"nullable": true
},
"last_name": {
"type": "string",
"description": "The last name of the emergency contact",
"nullable": true
},
"relationship": {
"type": "string",
"description": "The relationship of the emergency contact to the user",
"nullable": true
},
"relationship_id": {
"type": "integer",
"description": "The relationship ID for the user's emergency contact",
"format": "int32"
},
"relationship_user_id": {
"type": "integer",
"description": "The user ID of the emergency contact",
"format": "int32"
},
"sort_order": {
"type": "integer",
"description": "Sort order",
"format": "int32",
"nullable": true
},
"user_contact_id": {
"type": "integer",
"description": "User contact ID",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Emergency Contact Email Model"
},
"description": "List of emergency contact emails",
"nullable": true
},
"phone_contact_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Emergency contact phone ID",
"format": "int32"
},
"call_dialer": {
"type": "string",
"description": "Call dialer",
"nullable": true
},
"contact_id": {
"type": "integer",
"description": "Contact ID",
"format": "int32"
},
"first_name": {
"type": "string",
"description": "The first name of the emergency contact",
"nullable": true
},
"last_name": {
"type": "string",
"description": "The last name of the emergency contact",
"nullable": true
},
"phone_id": {
"type": "integer",
"description": "Phone ID",
"format": "int32"
},
"phone_index_id": {
"type": "integer",
"description": "Phone index ID",
"format": "int32"
},
"phone_number": {
"type": "string",
"description": "Phone number",
"nullable": true
},
"phone_type": {
"type": "string",
"description": "Phone type",
"nullable": true
},
"relationship": {
"type": "string",
"description": "The relationship of the emergency contact to the user",
"nullable": true
},
"relationship_id": {
"type": "integer",
"description": "The relationship ID of the emergency contact to the user",
"format": "int32"
},
"relationship_user_id": {
"type": "integer",
"description": "The user ID of the emergency contact",
"format": "int32"
},
"sort_order": {
"type": "integer",
"description": "Sort order",
"format": "int32",
"nullable": true
},
"user_contact_id": {
"type": "integer",
"description": "User contact ID",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Emergency Contact Phone Model"
},
"description": "List of emergency contact phones",
"nullable": true
}
},
"additionalProperties": false,
"description": "Emergency Contact List Model"
}Code samples
@ECHO OFF
curl -v -X GET "https://api.sky.blackbaud.com/school/v1/users/{user_id}/emergencycontacts"
-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/users/{user_id}/emergencycontacts?" + 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/users/{user_id}/emergencycontacts");
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/users/{user_id}/emergencycontacts?" + $.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/users/{user_id}/emergencycontacts";
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/users/{user_id}/emergencycontacts');
$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/users/{user_id}/emergencycontacts?%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/users/{user_id}/emergencycontacts?%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/users/{user_id}/emergencycontacts')
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