Constituent
This API manages constituent information and related entities such as addresses, phones, emails, and notes.
GET
Name format configuration list
Returns a list of all available name format configurations.
Try itRequest URL
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| constituent_id | array | The ID of the constituent to display the name format configurations in. |
|
| limit | integer | Represents the number of records to return. The default is 500. The maximum is 5000. |
|
| offset | integer | Represents the number of records to skip. For use with pagination. |
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 name format configuration entities.
{
"count": 45,
"value": [
{
"id": "47",
"format": "[Title 1] and [Spouse Title 1] [First Name] [Middle Name Initial] [Last Name] [Suffix 1]",
"formatted_name": "Dr. and Mrs. Robert C. Hernandez"
},
{
"id": "46",
"format": "[Title 1] and [Spouse Title 1] [First Name] [Middle Name Initial] [Last Name]",
"formatted_name": "Dr. and Mrs. Robert C. Hernandez"
},
{
"id": "1",
"format": "[Title 1] and [Spouse Title 1] [First Name] [Middle Name Initial] [Last Name] [Suffix 1] , Class of [Class Of]",
"formatted_name": "Dr. and Mrs. Robert C. Hernandez, Class of 1987"
},
{
"id": "2",
"format": "[Title 1] [First Name] [Middle Name Initial] [Last Name] and↵*[Spouse Title 1] [Spouse First Name] [Spouse Middle Name Initial] [Spouse Last Name]",
"formatted_name": "Dr. Robert C. Hernandez and\\ Mrs. Wendy Hernandez"
},
{
"id": "3",
"format": "[Spouse Title 1] and [Title 1] [Spouse First Name] [Spouse Middle Name Initial] [Spouse Last Name] [Spouse Suffix 1]",
"formatted_name": "Mrs. and Dr. Wendy Hernandez"
},
{
"id": "4",
"format": "[Spouse Title 1] [Spouse First Name] [Spouse Middle Name Initial] [Spouse Last Name] and↵*[Title 1] [First Name] [Middle Name Initial] [Last Name]",
"formatted_name": "Mrs. Wendy Hernandez and\\ Dr. Robert C. Hernandez"
},
{
"id": "5",
"format": "[Title 2] [First Name] and [Spouse First Name] [Last Name]",
"formatted_name": "Robert and Wendy Hernandez"
},
{
"id": "6",
"format": "[Title 1] [First Name] [Middle Name Initial] [Last Name] [Suffix 1]",
"formatted_name": "Dr. Robert C. Hernandez"
},
{
"id": "7",
"format": "[Title 1] [Title 2] [First Name] [Middle Name Initial] [Last Name] [Suffix 1]",
"formatted_name": "Dr. Robert C. Hernandez"
},
{
"id": "8",
"format": "[First Name] [Middle Name Initial] [Last Name] [Suffix 1]",
"formatted_name": "Robert C. Hernandez"
},
{
"id": "9",
"format": "[Last Name], [First Name] [Middle Name Initial]",
"formatted_name": "Hernandez, Robert C."
},
{
"id": "10",
"format": "[First Name] [Middle Name] [Last Name] [Suffix 1]",
"formatted_name": "Robert Carlos Hernandez"
},
{
"id": "11",
"format": "[Spouse Title 1] [Spouse First Name] [Spouse Middle Name Initial] [Spouse Last Name] [Spouse Suffix 1]",
"formatted_name": "Mrs. Wendy Hernandez"
},
{
"id": "12",
"format": "[Title 2] [Spouse First Name] [Spouse Middle Name Initial] [Spouse Last Name] [Spouse Suffix 1]",
"formatted_name": "Wendy Hernandez"
},
{
"id": "13",
"format": "[Spouse Title 1] [First Name] [Middle Name Initial] [Last Name] [Suffix 1]",
"formatted_name": "Mrs. Robert C. Hernandez"
},
{
"id": "14",
"format": "[Spouse Title 1] [Spouse First Name] [Spouse Last Name]-[Last Name]",
"formatted_name": "Mrs. Wendy Hernandez-Hernandez"
},
{
"id": "15",
"format": "[Spouse First Name] [Spouse Middle Name Initial] [Spouse Last Name] [Spouse Suffix 1]",
"formatted_name": "Wendy Hernandez"
},
{
"id": "16",
"format": "[Title 1] and [Spouse Title 1] [Last Name]",
"formatted_name": "Dr. and Mrs. Hernandez"
},
{
"id": "17",
"format": "[Title 1] [Last Name] and [Spouse Title 1] [Spouse Last Name]",
"formatted_name": "Dr. Hernandez and Mrs. Hernandez"
},
{
"id": "18",
"format": "[Title 1] [Last Name] and [Spouse Last Name]",
"formatted_name": "Dr. Hernandez and Hernandez"
},
{
"id": "19",
"format": "[Spouse Title 1] and [Title 1] [Spouse Last Name]",
"formatted_name": "Mrs. and Dr. Hernandez"
},
{
"id": "20",
"format": "[Spouse Title 1] [Spouse Last Name] and [Title 1] [Last Name]",
"formatted_name": "Mrs. Hernandez and Dr. Hernandez"
},
{
"id": "21",
"format": "[Title 1] [Last Name]",
"formatted_name": "Dr. Hernandez"
},
{
"id": "22",
"format": "[Title 2] [Last Name]",
"formatted_name": "Hernandez"
},
{
"id": "23",
"format": "[Title 1] [Former Name]-[Last Name]",
"formatted_name": "Dr.-Hernandez"
},
{
"id": "24",
"format": "[Spouse Title 1] [Spouse Last Name]",
"formatted_name": "Mrs. Hernandez"
},
{
"id": "25",
"format": "[Spouse Title 2] [Spouse Last Name]",
"formatted_name": "Hernandez"
},
{
"id": "26",
"format": "[Spouse Title 1] [Last Name]",
"formatted_name": "Mrs. Hernandez"
},
{
"id": "27",
"format": "[Spouse Title 1] [Spouse Middle Name]-[Spouse Last Name]",
"formatted_name": "Mrs.-Hernandez"
},
{
"id": "28",
"format": "[First Name] and [Spouse First Name]",
"formatted_name": "Robert and Wendy"
},
{
"id": "29",
"format": "[Spouse First Name] and [First Name]",
"formatted_name": "Wendy and Robert"
},
{
"id": "30",
"format": "[First Name] and [Spouse Nickname]",
"formatted_name": "Robert"
},
{
"id": "31",
"format": "[Spouse Nickname] and [First Name]",
"formatted_name": "and Robert"
},
{
"id": "32",
"format": "[Spouse First Name] and [Nickname]",
"formatted_name": "Wendy and Bob"
},
{
"id": "33",
"format": "[Nickname] and [Spouse First Name]",
"formatted_name": "Bob and Wendy"
},
{
"id": "34",
"format": "[First Name]",
"formatted_name": "Robert"
},
{
"id": "35",
"format": "[Nickname]",
"formatted_name": "Bob"
},
{
"id": "36",
"format": "[Middle Name]",
"formatted_name": "Carlos"
},
{
"id": "37",
"format": "[Spouse First Name]",
"formatted_name": "Wendy"
},
{
"id": "38",
"format": "[Spouse Nickname]"
},
{
"id": "39",
"format": "[Spouse Middle Name]"
},
{
"id": "42",
"format": "[Organization Name]",
"formatted_name": "Davis & Johnson Pharmaceuticals"
},
{
"id": "43",
"format": "[Title 1]",
"formatted_name": "Dr."
},
{
"id": "44",
"format": "Friend",
"formatted_name": "Friend"
},
{
"id": "45",
"format": "[Title 1] [First Name] [Last Name] and Guest",
"formatted_name": "Dr. Robert Hernandez and Guest"
}
]
}{
"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": "Name format configurations provide a preset layout to display a constituent's name.",
"type": "object",
"properties": {
"id": {
"description": "The name format configuration identifier.",
"type": "string"
},
"format": {
"description": "The name format.",
"type": "string"
},
"formatted_name": {
"description": "The preview of the format applied to the given constituent's name.",
"type": "string"
}
},
"x-display-name": "Name format configuration",
"x-display-id": "NameFormatConfiguration"
}
}
},
"x-hidden": true,
"x-base-type": "#/definitions/ApiCollection"
}Response 403 Forbidden
Returned when the user does not have permission to view the name format configurations.
Code samples
@ECHO OFF
curl -v -X GET "https://api.sky.blackbaud.com/constituent/v1/nameformatconfigurations?constituent_id={array}&limit={integer}&offset={integer}"
-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["constituent_id"] = "{array}";
queryString["limit"] = "{integer}";
queryString["offset"] = "{integer}";
var uri = "https://api.sky.blackbaud.com/constituent/v1/nameformatconfigurations?" + 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/nameformatconfigurations");
builder.setParameter("constituent_id", "{array}");
builder.setParameter("limit", "{integer}");
builder.setParameter("offset", "{integer}");
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
"constituent_id": "{array}",
"limit": "{integer}",
"offset": "{integer}",
};
$.ajax({
url: "https://api.sky.blackbaud.com/constituent/v1/nameformatconfigurations?" + $.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/nameformatconfigurations";
NSArray* array = @[
// Request parameters
@"entities=true",
@"constituent_id={array}",
@"limit={integer}",
@"offset={integer}",
];
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/nameformatconfigurations');
$url = $request->getUrl();
$headers = array(
// Request headers
'Bb-Api-Subscription-Key' => '{subscription key}',
'Authorization' => 'Bearer {access token}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'constituent_id' => '{array}',
'limit' => '{integer}',
'offset' => '{integer}',
);
$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
'constituent_id': '{array}',
'limit': '{integer}',
'offset': '{integer}',
})
try:
conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/constituent/v1/nameformatconfigurations?%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
'constituent_id': '{array}',
'limit': '{integer}',
'offset': '{integer}',
})
try:
conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/constituent/v1/nameformatconfigurations?%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/nameformatconfigurations')
query = URI.encode_www_form({
# Request parameters
'constituent_id' => '{array}',
'limit' => '{integer}',
'offset' => '{integer}'
})
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