School

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

POST

Users address create

Returns the ID of the address just created.
Requires at least one of the following roles in the Education Management system:

  • SKY API Data Sync

Try it

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
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, Implicit.

Request body

Address information to be updated.

{
  "city": "string",
  "country": "string",
  "line_one": "string",
  "line_two": "string",
  "line_three": "string",
  "mailing_address": true,
  "postal_code": "string",
  "primary": true,
  "province": "string",
  "region": "string",
  "state": "string",
  "type_id": 0,
  "user_id": 0,
  "links": [
    {
      "type_id": 0,
      "primary": true,
      "shared": true,
      "shared_relationship": "string",
      "shared_user": "string",
      "type": "string",
      "user_id": 0
    }
  ]
}
{
  "type": "object",
  "properties": {
    "city": {
      "type": "string",
      "description": "The city for the address",
      "nullable": true
    },
    "country": {
      "type": "string",
      "description": "The country for the address (Full Name e.g. United States)",
      "nullable": true
    },
    "line_one": {
      "type": "string",
      "description": "The first line of the address",
      "nullable": true
    },
    "line_two": {
      "type": "string",
      "description": "The second line of the address",
      "nullable": true
    },
    "line_three": {
      "type": "string",
      "description": "The third line of the address",
      "nullable": true
    },
    "mailing_address": {
      "type": "boolean",
      "description": "Returns True if user accepts mail from the address"
    },
    "postal_code": {
      "type": "string",
      "description": "The postal code for the address",
      "nullable": true
    },
    "primary": {
      "type": "boolean",
      "description": "Returns true if the address is primary"
    },
    "province": {
      "type": "string",
      "description": "The province for the address",
      "nullable": true
    },
    "region": {
      "type": "string",
      "description": "The region for the address",
      "nullable": true
    },
    "state": {
      "type": "string",
      "description": "The state for the address",
      "nullable": true
    },
    "type_id": {
      "type": "integer",
      "description": "The type ID associated with an address that is based upon a user's primary relationship to the address",
      "format": "int32",
      "nullable": true
    },
    "user_id": {
      "type": "integer",
      "description": "The ID of the user of the address",
      "format": "int32",
      "nullable": true
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type_id": {
            "type": "integer",
            "description": "The ID of the type",
            "format": "int32",
            "nullable": true
          },
          "primary": {
            "type": "boolean",
            "description": "Returns true if the address is primary"
          },
          "shared": {
            "type": "boolean",
            "description": "Returns true if changes to an address are made to all users with a shared relationship (Read Only)"
          },
          "shared_relationship": {
            "type": "string",
            "description": "The relationship of the shared user",
            "nullable": true
          },
          "shared_user": {
            "type": "string",
            "description": "The name of the shared user",
            "nullable": true
          },
          "type": {
            "type": "string",
            "description": "The name of the address type",
            "nullable": true
          },
          "user_id": {
            "type": "integer",
            "description": "The ID of the user",
            "format": "int32",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "AddressTypeLink Model"
      },
      "description": "Returns each instance of an address type for each relationship to the user",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "AddressAdd Model"
}

Response 200 OK

ID of the address just added.

465879213
{
  "type": "integer",
  "format": "int64",
  "x-apim-inline": true
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.sky.blackbaud.com/school/v1/users/{user_id}/addresses"
-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/{user_id}/addresses?" + 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/{user_id}/addresses");


            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/{user_id}/addresses?" + $.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/{user_id}/addresses";
    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/{user_id}/addresses');
$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/{user_id}/addresses?%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/{user_id}/addresses?%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}/addresses')

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

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!