School
This API is used to provide access to school information such as users, academics, admissions, athletics, content, lists, and general school info.
POST
User create
Creates a new user record.
Returns the newly created ID.
Requires at least one of the following roles in the Education Management system:
- SKY API Data Sync
Request URL
Request headers
| Header | Required | Type | Description |
|---|---|---|---|
| Content-Type | string | Media type of the body sent to the API. | |
| 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. |
Request body
The user to be created
{
"custom_field_eight": "custom value",
"custom_field_five": "custom value",
"custom_field_four": "custom value",
"custom_field_nine": "custom value",
"custom_field_one": "custom value",
"custom_field_seven": "custom value",
"custom_field_six": "custom value",
"custom_field_ten": "custom value",
"custom_field_three": "custom value",
"custom_field_two": "custom value",
"deceased": false,
"dob": "0001-01-01T12:00:00Z",
"email": "example@example.com",
"email_active": true,
"first_name": "John",
"host_id": "example-host-id",
"is_responsible_signer": false,
"last_name": "Smith",
"lost": false,
"maiden_name": "",
"middle_name": "Nolan",
"prefix": "Mr.",
"suffix": "III"
}{
"type": "object",
"properties": {
"affiliation": {
"type": "string",
"description": "The affiliation of a user",
"nullable": true
},
"birth_place": {
"type": "string",
"description": "The birthplace of the user",
"nullable": true
},
"boarding_or_day": {
"type": "string",
"description": "The boarding or day status. Accepted values: boarding, day, \"B\" and \"D\"",
"nullable": true
},
"cc_email": {
"type": "string",
"description": "The cc email address of a user",
"nullable": true
},
"citizenship": {
"type": "string",
"description": "The descriptor or ID of the citizenship. Descriptors are not case sensitive, but otherwise must match the table value exactly. These values are returned by GET Types table values.",
"nullable": true
},
"custom_field_eight": {
"type": "string",
"description": "A custom field on the user profile (eight of ten)",
"nullable": true
},
"custom_field_five": {
"type": "string",
"description": "A custom field on the user profile (five of ten)",
"nullable": true
},
"custom_field_four": {
"type": "string",
"description": "A custom field on the user profile (four of ten)",
"nullable": true
},
"custom_field_nine": {
"type": "string",
"description": "A custom field on the user profile (nine of ten)",
"nullable": true
},
"custom_field_one": {
"type": "string",
"description": "A custom field on the user profile (one of ten)",
"nullable": true
},
"custom_field_seven": {
"type": "string",
"description": "A custom field on the user profile (seven of ten)",
"nullable": true
},
"custom_field_six": {
"type": "string",
"description": "A custom field on the user profile (six of ten)",
"nullable": true
},
"custom_field_ten": {
"type": "string",
"description": "A custom field on the user profile (ten of ten)",
"nullable": true
},
"custom_field_three": {
"type": "string",
"description": "A custom field on the user profile (three of ten)",
"nullable": true
},
"custom_field_two": {
"type": "string",
"description": "A custom field on the user profile (two of ten)",
"nullable": true
},
"deceased": {
"type": "boolean",
"description": "Set to true if the user is deceased. Allowed value: true, false. Defaults to false."
},
"deceased_date": {
"type": "string",
"description": "The deceased date of the user. Use ISO-8601 date format: 2022-04-08.",
"format": "date-time",
"nullable": true
},
"dob": {
"type": "string",
"description": "The birthday of a user",
"format": "date-time"
},
"email": {
"type": "string",
"description": "The email address of a user",
"nullable": true
},
"email_active": {
"type": "boolean",
"description": "Set to true if email is usable. Allowed value: true, false. Defaults to true."
},
"ethnicity": {
"type": "string",
"description": "The descriptor or ID of the ethnicity. Descriptors are not case sensitive, but otherwise must match the table value exactly. These values are returned by GET Types table values.",
"nullable": true
},
"first_name": {
"type": "string",
"description": "The first name of a user",
"nullable": true
},
"gender": {
"type": "string",
"description": "The gender of a user",
"nullable": true
},
"greeting": {
"type": "string",
"description": "The greeting of a user",
"nullable": true
},
"host_id": {
"type": "string",
"description": "The HostId of a user",
"nullable": true
},
"is_abroad": {
"type": "boolean",
"description": "Set to true if user is currently abroad. Allowed value: true, false. Defaults to false.",
"nullable": true
},
"is_international": {
"type": "boolean",
"description": "Set to true if user is international",
"nullable": true
},
"is_latino_hispanic": {
"type": "boolean",
"description": "Set to true if user is latino or hispanic.",
"nullable": true
},
"is_responsible_signer": {
"type": "boolean",
"description": "Set to true if user is a responsible signer. Allowed value: true, false. Defaults to false."
},
"in_state": {
"type": "object",
"properties": {
"resident": {
"type": "boolean",
"description": "Set to true if user is an in state resident.",
"nullable": true
},
"county": {
"type": "string",
"description": "The county of residence of the user.",
"nullable": true
},
"from_date": {
"type": "string",
"description": "The date the user has resided in the county of residence. Use ISO-8601 date format: 2022-04-21.",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "An object for in-state resident information"
},
"last_name": {
"type": "string",
"description": "The last name of a user",
"nullable": true
},
"living_status": {
"type": "string",
"description": "The descriptor or ID of the living status. Descriptors are not case sensitive, but otherwise must match the table value exactly. These values are returned by GET Types table values.",
"nullable": true
},
"locker": {
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "The locker number of the user.",
"nullable": true
},
"combo": {
"type": "string",
"description": "The locker combination of the user.",
"nullable": true
}
},
"additionalProperties": false,
"description": "An object for locker information"
},
"lost": {
"type": "boolean",
"description": "Set to true if user is set as lost"
},
"maiden_name": {
"type": "string",
"description": "The maiden name of a user",
"nullable": true
},
"mailbox": {
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "The mailbox number of the user.",
"nullable": true
},
"combo": {
"type": "string",
"description": "The mailbox combination of the user.",
"nullable": true
}
},
"additionalProperties": false,
"description": "An object for mailbox information"
},
"middle_name": {
"type": "string",
"description": "The middle name of a user",
"nullable": true
},
"passport": {
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "The passport number of the user.",
"nullable": true
},
"expire_date": {
"type": "string",
"description": "The passport expiry date. Use ISO-8601 date format: 2022-04-21.",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "An object for passport information"
},
"primary_language": {
"type": "string",
"description": "The descriptor or ID of the language. Descriptors are not case sensitive, but otherwise must match the table value exactly. These values are returned by GET Types table values.",
"nullable": true
},
"preferred_name": {
"type": "string",
"description": "The preferred name of the user",
"nullable": true
},
"prefix": {
"type": "string",
"description": "The prefix of a user",
"nullable": true
},
"pronouns": {
"type": "string",
"description": "The descriptor or ID of the pronouns. Descriptors are not case sensitive, but otherwise must match the table value exactly. These values are returned by GET Types table values.",
"nullable": true
},
"religion": {
"type": "string",
"description": "The descriptor or ID of the religion. Descriptors are not case sensitive, but otherwise must match the table value exactly. These values are returned by GET Types table values.",
"nullable": true
},
"school_program": {
"type": "string",
"description": "The descriptor or ID of the school program. Descriptors are not case sensitive, but otherwise must match the table value exactly. These values are returned by GET Types table values.",
"nullable": true
},
"state_id": {
"type": "string",
"description": "The state assigned ID of the user",
"nullable": true
},
"student_id": {
"type": "string",
"description": "The school assigned ID of the user",
"nullable": true
},
"suffix": {
"type": "string",
"description": "The suffix of a user",
"nullable": true
},
"visa": {
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "The visa number of the user.",
"nullable": true
},
"status": {
"type": "string",
"description": "The descriptor or ID of the visa status. Descriptors are not case sensitive, but otherwise must match the table value exactly.",
"nullable": true
},
"type": {
"type": "string",
"description": "The descriptor or ID of the visa type. Descriptors are not case sensitive, but otherwise must match the table value exactly.",
"nullable": true
},
"issue_date": {
"type": "string",
"description": "The visa issue date. Use ISO-8601 date format: 2022-04-21.",
"format": "date-time",
"nullable": true
},
"expire_date": {
"type": "string",
"description": "The visa expiry date. Use ISO-8601 date format: 2022-04-21.",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "An object for visa information"
}
},
"additionalProperties": false,
"description": "UserAdd Model"
}Response 200 OK
ID of the user just created.
456123789{
"type": "integer",
"format": "int64",
"x-apim-inline": true
}Code samples
@ECHO OFF
curl -v -X POST "https://api.sky.blackbaud.com/school/v1/users"
-H "Content-Type: application/json"
-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?" + queryString;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
var response = await client.PostAsync(uri, content);
}
}
}
}// // 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");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Content-Type", "application/json");
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?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Bb-Api-Subscription-Key","{subscription key}");
xhrObj.setRequestHeader("Authorization","Bearer {access token}");
},
type: "POST",
// 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";
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:@"POST"];
// Request headers
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_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');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json',
'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_POST);
// 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
'Content-Type': 'application/json',
'Bb-Api-Subscription-Key': '{subscription key}',
'Authorization': 'Bearer {access token}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
conn.request("POST", "/school/v1/users?%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
'Content-Type': 'application/json',
'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("POST", "/school/v1/users?%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')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
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