Statistical Unit

This API manages information related to tracking statistical units for financial reporting and allocations.

GET

Unit (Search)

Searches for non-financial statistical units.

Try it

Request URL

Request parameters

Parameter Required Type Description
sort array

Ordered array of field names by which to sort results. Prefix "-" to sort in descending order. For exampe, ["-name"] sorts by name in descending order. Name is the only supported option.

offset integer

Represents the number of records to skip. For use with pagination.

limit integer

Represents the number of records to return. The default is 100. The maximum allowed value is 5000.

include_inactive boolean

Represents whether to include inactive units in the results. The default is false.

search_text string

Filters search results based on unit names. The default value is an empty string.

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 unit entities.

{
  "count": 4,
  "value": [
    {
      "id": 65,
      "name": "Square feet",
      "description": "Total space in the building.",
      "integer": true,
      "cumulative": false,
      "inactive": true,
      "elements": [
        {
          "id": 5
        }
      ]
    }
  ]
}
{
  "description": "A collection of units.",
  "type": "object",
  "properties": {
    "count": {
      "format": "int32",
      "description": "Number of items in the collection",
      "type": "integer"
    },
    "value": {
      "description": "Items in the collection",
      "type": "array",
      "items": {
        "description": "A unit represents a type of non-financial, numerical data.",
        "type": "object",
        "properties": {
          "id": {
            "format": "int32",
            "description": "Unit ID",
            "type": "integer"
          },
          "cumulative": {
            "description": "Whether the counts of the unit accumulate",
            "type": "boolean"
          },
          "description": {
            "description": "Description of the unit",
            "type": "string"
          },
          "elements": {
            "description": "Elements that relate to the unit",
            "type": "array",
            "items": {
              "description": "An element represents a dimension by which units can be tracked.",
              "type": "object",
              "properties": {
                "id": {
                  "format": "int32",
                  "description": "Element ID",
                  "type": "integer"
                }
              }
            }
          },
          "inactive": {
            "description": "Whether the unit is active",
            "type": "boolean"
          },
          "integer": {
            "description": "Whether the unit accepts only integer count values",
            "type": "boolean"
          },
          "name": {
            "description": "Name of the unit",
            "type": "string"
          }
        }
      }
    }
  }
}

Response 400 Bad Request

Returned when one or more invalid request parameters were provided.

{
  "message": "The value 'xxx' is not valid for Int32.",
  "error_code": 0,
  "raw_message": "The value 'xxx' is not valid for Int32."
}
{
  "type": "array",
  "items": {
    "description": "An array of service errors is returned when a request could not be completed.",
    "type": "object",
    "properties": {
      "error_code": {
        "format": "int32",
        "description": "Code number of the service error",
        "type": "integer"
      },
      "error_name": {
        "description": "The name of the service error",
        "type": "string"
      },
      "message": {
        "description": "The message of the service error",
        "type": "string"
      }
    }
  }
}

Response 403 Forbidden

Returned when the user does not have permission to view units.

[
  {
    "error_name": "Forbidden",
    "message": "User does not have permissions needed to access this record.",
    "error_code": 403,
    "raw_message": "User does not have permissions needed to access this record."
  }
]
{
  "type": "array",
  "items": {
    "description": "An array of service errors is returned when a request could not be completed.",
    "type": "object",
    "properties": {
      "error_code": {
        "format": "int32",
        "description": "Code number of the service error",
        "type": "integer"
      },
      "error_name": {
        "description": "The name of the service error",
        "type": "string"
      },
      "message": {
        "description": "The message of the service error",
        "type": "string"
      }
    }
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.sky.blackbaud.com/statisticalunit/v1/units?sort={array}&offset={integer}&limit={integer}&include_inactive={boolean}&search_text={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["sort"] = "{array}";
            queryString["offset"] = "{integer}";
            queryString["limit"] = "{integer}";
            queryString["include_inactive"] = "{boolean}";
            queryString["search_text"] = "{string}";
            var uri = "https://api.sky.blackbaud.com/statisticalunit/v1/units?" + 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/statisticalunit/v1/units");

            builder.setParameter("sort", "{array}");
            builder.setParameter("offset", "{integer}");
            builder.setParameter("limit", "{integer}");
            builder.setParameter("include_inactive", "{boolean}");
            builder.setParameter("search_text", "{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
            "sort": "{array}",
            "offset": "{integer}",
            "limit": "{integer}",
            "include_inactive": "{boolean}",
            "search_text": "{string}",
        };

        $.ajax({
            url: "https://api.sky.blackbaud.com/statisticalunit/v1/units?" + $.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/statisticalunit/v1/units";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"sort={array}",
                         @"offset={integer}",
                         @"limit={integer}",
                         @"include_inactive={boolean}",
                         @"search_text={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/statisticalunit/v1/units');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'sort' => '{array}',
    'offset' => '{integer}',
    'limit' => '{integer}',
    'include_inactive' => '{boolean}',
    'search_text' => '{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
    'sort': '{array}',
    'offset': '{integer}',
    'limit': '{integer}',
    'include_inactive': '{boolean}',
    'search_text': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/statisticalunit/v1/units?%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
    'sort': '{array}',
    'offset': '{integer}',
    'limit': '{integer}',
    'include_inactive': '{boolean}',
    'search_text': '{string}',
})

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

query = URI.encode_www_form({
    # Request parameters
    'sort' => '{array}',
    'offset' => '{integer}',
    'limit' => '{integer}',
    'include_inactive' => '{boolean}',
    'search_text' => '{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!