Gift
This API manages gift information and related entities such as gift splits, gift fundraisers, and soft credits.
Request URL
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| gift_id | Property is required | string | The immutable system record ID of the gift to retrieve custom fields 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 a collection of custom field entities.
{
"count": 5,
"value": [
{
"id": "273",
"category": "Reminder Sent",
"comment": "Reminder sent to home address",
"date": "2017-12-01T00:00:00Z",
"parent_id": "2279",
"type": "Boolean",
"value": true
},
{
"id": "274",
"category": "Source",
"date": "2017-01-05T00:00:00Z",
"parent_id": "2279",
"type": "CodeTableEntry",
"value": "Radio"
},
{
"id": "275",
"category": "Deposit Date",
"date": "2018-01-15T00:00:00Z",
"parent_id": "2279",
"type": "Date",
"value": "2018-01-15T00:00:00Z"
},
{
"id": "276",
"category": "Item Number",
"parent_id": "2279",
"type": "Number",
"value": 1
},
{
"id": "277",
"category": "Donated By",
"date": "2018-01-12T00:00:00Z",
"parent_id": "2279",
"type": "ConstituentId",
"value": "190"
}
]
}{
"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": "While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.",
"type": "object",
"properties": {
"id": {
"description": "The immutable system record ID of the custom field.",
"type": "string"
},
"category": {
"description": "The custom field category. Available values are the entries in the <b>Custom Field Categories</b> table of the parent object.",
"type": "string"
},
"comment": {
"description": "The comment on the custom field.",
"type": "string"
},
"date": {
"format": "date-time",
"description": "The date on the custom field. 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 custom field was created. The date 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 custom field was last modified. The date 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
},
"parent_id": {
"description": "The parent object's immutable system record ID.",
"type": "string"
},
"type": {
"description": "The type of data that the custom field represents. Available values are listed below.",
"enum": [
"Text",
"Number",
"Date",
"Currency",
"Boolean",
"CodeTableEntry",
"ConstituentId",
"FuzzyDate"
],
"type": "string"
},
"value": {
"description": "The value of the custom field. The <code>type</code> property determines the format.",
"type": "object"
}
},
"x-display-name": "Custom field",
"x-display-id": "CustomField",
"x-additional-info": "<a name=\"CustomFieldTypes\"></a>\r\n<p> </p>\r\n<p>\r\n Available values for the <b>type</b> of a <b>custom field</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 custom field as a boolean value.</td>\r\n </tr>\r\n <tr>\r\n <td>CodeTableEntry</td>\r\n <td>Defines the custom field as a string value that represents a code table entry description.</td>\r\n </tr>\r\n <tr>\r\n <td>ConstituentId</td>\r\n <td>Defines the custom field as a constituent identifier value.</td>\r\n </tr>\r\n <tr>\r\n <td>Currency</td>\r\n <td>Defines the custom field as a decimal value.</td>\r\n </tr>\r\n <tr>\r\n <td>Date</td>\r\n <td>\r\n Defines the custom field as a date value 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>FuzzyDate</td>\r\n <td>\r\n Defines the custom field as a fuzzy date value.\r\n </td>\r\n </tr>\r\n <tr>\r\n <td>Number</td>\r\n <td>Defines the custom field as an integer value.</td>\r\n </tr>\r\n <tr>\r\n <td>Text</td>\r\n <td>Defines the custom field as a string value. Character limit: 255.</td>\r\n </tr>\r\n </tbody>\r\n </table>\r\n</div>"
}
}
},
"x-hidden": true,
"x-base-type": "#/definitions/ApiCollection"
}Response 400 Bad Request
Returned when the specified gift 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 custom fields.
Response 404 Not Found
Returned when the specified gift is not found.
Code samples
@ECHO OFF
curl -v -X GET "https://api.sky.blackbaud.com/gift/v1/gifts/{gift_id}/customfields"
-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/gift/v1/gifts/{gift_id}/customfields?" + 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/gift/v1/gifts/{gift_id}/customfields");
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/gift/v1/gifts/{gift_id}/customfields?" + $.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/gift/v1/gifts/{gift_id}/customfields";
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/gift/v1/gifts/{gift_id}/customfields');
$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", "/gift/v1/gifts/{gift_id}/customfields?%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", "/gift/v1/gifts/{gift_id}/customfields?%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/gift/v1/gifts/{gift_id}/customfields')
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