Constituent
This API manages constituent information and related entities such as addresses, phones, emails, and notes.
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 ratings for. |
| include_inactive | boolean | Set this parameter to "true" to include inactive ratings in the response. |
|
| most_recent_only | boolean | Set this parameter to "true" to include only the most recent ratings |
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 rating entities.
{
"count": 3,
"value": [
{
"id": "579",
"category": "Annual Giving Capacity - WP",
"comment": "This has been recently adjusted.",
"constituent_id": "280",
"date": "2006-08-26T00:00:00",
"inactive": false,
"source": "Blackbaud Analytics - WP",
"type": "Text",
"value": "$100,001 - $200,000"
},
{
"id": "577",
"category": "Annual Giving Likelihood - WP",
"constituent_id": "280",
"date": "2006-08-26T00:00:00",
"inactive": false,
"source": "Blackbaud Analytics - WP",
"type": "Text",
"value": "774"
},
{
"id": "576",
"category": "Estimated Wealth Rating - WP",
"constituent_id": "280",
"date": "2006-08-26T00:00:00",
"inactive": false,
"source": "Blackbaud Analytics - WP",
"type": "Text",
"value": "$10,000,000+"
}
]
}{
"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": "Ratings indicate the estimated wealth of constituents and their capacity to give. Ratings information such as overall wealth ratings, suggested ask amounts, and total identified assets can help to determine where to focus efforts, whether to pursue prospects or major gifts, and how much to ask from donors.",
"type": "object",
"properties": {
"id": {
"description": "The immutable system record ID of the rating.",
"type": "string"
},
"category": {
"description": "The category of the rating. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListRatingCategories\"><b>Rating Categories</b></a> table.",
"type": "string"
},
"comment": {
"description": "A comment about the rating.",
"type": "string"
},
"constituent_id": {
"description": "The immutable system record ID of the constituent associated with the rating.",
"type": "string"
},
"date": {
"format": "date-time",
"description": "The date of the rating. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
"type": "string",
"x-supports-datetime-offset": false
},
"inactive": {
"description": "This computed field indicates that the rating is active if the <code>category</code> is active.",
"type": "boolean"
},
"source": {
"description": "The source of the rating.",
"type": "string"
},
"type": {
"description": "This computed field indicates the type of data that the rating represents based on the <code>category</code> property. Available values <a href=\"#RatingTypes\">are listed below</a>.",
"enum": [
"Text",
"Number",
"DateTime",
"Currency",
"Boolean",
"CodeTable",
"Unknown"
],
"type": "string"
},
"value": {
"description": "The value of the rating. The <code>type</code> property determines the format.",
"type": "object"
}
},
"x-display-name": "Rating",
"x-display-id": "Rating",
"x-additional-info": "<a name=\"RatingTypes\"></a>\r\n<p> </p>\r\n<p>\r\n Available values for the <b>type</b> of a <b>rating</b>:\r\n</p>\r\n\r\n<div class=\"table-responsive\">\r\n <table class=\"table table-striped table-hover\">\r\n <thead>\r\n <tr>\r\n <th class=\"col-xs-3\"><strong>Type</strong></th>\r\n <th class=\"col-xs-9\"><strong>Description</strong></th>\r\n </tr>\r\n </thead>\r\n <tbody>\r\n <tr>\r\n <td>Boolean</td>\r\n <td>Defines the rating value as a boolean JSON data type.</td>\r\n </tr>\r\n <tr>\r\n <td>CodeTable</td>\r\n <td>Defines the rating value as a string JSON data type that refers to a code table entry.</td>\r\n </tr>\r\n <tr>\r\n <td>Currency</td>\r\n <td>Defines the rating value as a number JSON data type.</td>\r\n </tr>\r\n <tr>\r\n <td>DateTime</td>\r\n <td>\r\n Defines the rating value as a string JSON data type in <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.\r\n </td>\r\n </tr>\r\n <tr>\r\n <td>Number</td>\r\n <td>Defines the rating value as a number JSON data type.</td>\r\n </tr>\r\n <tr>\r\n <td>Text</td>\r\n <td>Defines the rating value as a string JSON data type.</td>\r\n </tr>\r\n </tbody>\r\n </table>\r\n</div>\r\n"
}
}
},
"x-hidden": true,
"x-base-type": "#/definitions/ApiCollection"
}Response 400 Bad Request
Returned when the specified constituent ID in the request URL or the specified request parameter is not in the appropriate format.
Response 403 Forbidden
Returned when the user does not have permission to view the ratings.
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}/ratings?include_inactive={boolean}&most_recent_only={boolean}"
-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["include_inactive"] = "{boolean}";
queryString["most_recent_only"] = "{boolean}";
var uri = "https://api.sky.blackbaud.com/constituent/v1/constituents/{constituent_id}/ratings?" + 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}/ratings");
builder.setParameter("include_inactive", "{boolean}");
builder.setParameter("most_recent_only", "{boolean}");
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
"include_inactive": "{boolean}",
"most_recent_only": "{boolean}",
};
$.ajax({
url: "https://api.sky.blackbaud.com/constituent/v1/constituents/{constituent_id}/ratings?" + $.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}/ratings";
NSArray* array = @[
// Request parameters
@"entities=true",
@"include_inactive={boolean}",
@"most_recent_only={boolean}",
];
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}/ratings');
$url = $request->getUrl();
$headers = array(
// Request headers
'Bb-Api-Subscription-Key' => '{subscription key}',
'Authorization' => 'Bearer {access token}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'include_inactive' => '{boolean}',
'most_recent_only' => '{boolean}',
);
$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
'include_inactive': '{boolean}',
'most_recent_only': '{boolean}',
})
try:
conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/constituent/v1/constituents/{constituent_id}/ratings?%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
'include_inactive': '{boolean}',
'most_recent_only': '{boolean}',
})
try:
conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/constituent/v1/constituents/{constituent_id}/ratings?%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}/ratings')
query = URI.encode_www_form({
# Request parameters
'include_inactive' => '{boolean}',
'most_recent_only' => '{boolean}'
})
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