Constituent
This API manages constituent information and related entities such as addresses, phones, emails, and notes.
Request URL
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| action_id | Property is required | string | The immutable system record ID of the action to retrieve information for. |
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
Returned when the operation succeeds. The response body contains the specified action entity.
{
"id": "410",
"category": "Mailing",
"completed": true,
"completed_date": "2009-02-24T00:00:00Z",
"computed_status": "Completed",
"constituent_id": "280",
"date": "2009-02-19T00:00:00Z",
"date_added": "1999-10-26T15:45:27.463Z",
"date_modified": "2004-02-27T18:46:06.237Z",
"description": "Send invitation for Dr. Hernandez to attend our board meetings. Send schedule of meetings.",
"direction": "Outbound",
"end_time": "13:30",
"fundraisers": [
"252"
],
"location": "Rafferty's",
"outcome": "Successful",
"priority": "Normal",
"start_time": "12:00",
"status": "Closed",
"status_code": "Closed",
"summary": "Sent invitation for Dr. Hernandez to attend our board meetings. Sent schedule of meetings.",
"type": "Brochure/Invitation"
}{
"description": "Actions track the interactions and tasks that are required to secure gifts and cultivate relationships with constituents.",
"type": "object",
"properties": {
"id": {
"description": "The immutable system record ID of the action.",
"type": "string"
},
"category": {
"description": "The channel or intent of the constituent interaction. Available values are <i>Phone Call</i>, <i>Meeting</i>, <i>Mailing</i>, <i>Email</i>, and <i>Task/Other</i>.",
"type": "string"
},
"completed": {
"description": "Indicates whether the action is complete. If the system is configured to use custom action statuses, this value is based on the action status value. This property defaults to <i>false</i> if no value is provided.",
"type": "boolean"
},
"completed_date": {
"format": "date-time",
"description": "The date when the action was completed. 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
},
"computed_status": {
"description": "The computed action status. If the system is not configured to use custom action statuses, this field computes the status based on the <code>completed</code> and <code>date</code> properties. If not, the field calculates the status based on the action's date property and whether action's <code>Action Status</code> property is configured as completed.",
"enum": [
"Open",
"Completed",
"PastDue"
],
"type": "string"
},
"constituent_id": {
"description": "The immutable system record ID of the constituent associated with the action.",
"type": "string"
},
"date": {
"format": "date-time",
"description": "The action date. 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
},
"date_added": {
"format": "date-time",
"description": "The date when the action was created. Includes an offset from UTC in <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43-04:00</i>.",
"type": "string",
"x-supports-datetime-offset": true
},
"date_modified": {
"format": "date-time",
"description": "The date when the action was last modified. Includes an offset from UTC in <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43-04:00</i>.",
"type": "string",
"x-supports-datetime-offset": true
},
"description": {
"description": "The detailed explanation that elaborates on the action summary.",
"type": "string"
},
"direction": {
"description": "The direction of the action. Available values are <i>Inbound</i> and <i>Outbound</i>.",
"enum": [
"Inbound",
"Outbound"
],
"type": "string"
},
"end_time": {
"description": "The end time of the action. Uses 24-hour time in the <i>HH:mm</i> format. For example, 17:30 represents 5:30 p.m.",
"type": "string"
},
"fundraisers": {
"description": "The set of immutable constituent system record IDs for the fundraisers associated with the action.",
"type": "array",
"items": {
"type": "string"
}
},
"location": {
"description": "The location of the action. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListActionLocations\"><b>Action Locations</b></a> table.",
"type": "string"
},
"opportunity_id": {
"description": "The immutable system record ID of the opportunity associated with the action.",
"type": "string"
},
"outcome": {
"description": "The outcome of the action. Available values are <i>Successful</i> and <i>Unsuccessful</i>.",
"enum": [
"Successful",
"Unsuccessful"
],
"type": "string"
},
"priority": {
"description": "The priority of the action. Available values are <i>Normal</i>, <i>High</i>, and <i>Low</i>. The default is <i>Normal</i>.",
"enum": [
"Normal",
"High",
"Low"
],
"type": "string"
},
"start_time": {
"description": "The start time of the action. Uses 24-hour time in the <i>HH:mm</i> format. For example, 17:30 represents 5:30 p.m.",
"type": "string"
},
"status": {
"description": "The action status. If the system is configured to use custom action statuses, available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListActionStatusTypes\"><b>Action Status</b></a> table. If not, this field computes the status based on the <code>completed</code> and <code>date</code> properties: If an action is not completed and has a current or future date, the status is Open; if an action is not completed and has a past date, the status is Past due; and if an action is completed, the status is Completed.",
"type": "string"
},
"status_code": {
"description": "The action status code. Available values are in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListActionStatusTypes\"><b>Action Status</b></a> table. This property is only returned when the system is configured to use custom action statuses.",
"type": "string"
},
"summary": {
"description": "The short description of the action that appears at the top of the record.",
"type": "string"
},
"type": {
"description": "Additional description of the action to complement the category. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListActionTypes\"><b>Actions</b></a> table.",
"type": "string"
}
},
"x-display-name": "Action",
"x-display-id": "Action"
}Response 400 Bad Request
Returned when the specified constituent ID in the request URL is not in the appropriate format.
Response 403 Forbidden
Returned when the user does not have permission to view the action.
Response 404 Not Found
Returned when the specified action is not found.
Code samples
@ECHO OFF
curl -v -X GET "https://api.sky.blackbaud.com/constituent/v1/actions/{action_id}"
-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/constituent/v1/actions/{action_id}?" + 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/actions/{action_id}");
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/constituent/v1/actions/{action_id}?" + $.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/actions/{action_id}";
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/constituent/v1/actions/{action_id}');
$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", "/constituent/v1/actions/{action_id}?%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", "/constituent/v1/actions/{action_id}?%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/actions/{action_id}')
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