Constituent

This API manages constituent information and related entities such as addresses, phones, emails, and notes.

GET

Name format summary

Returns the name format summary for a constituent.

Try it

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 name format summary 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, Implicit.

Response 200 OK

Returned when the operation succeeds. The response body contains a name format summary entity.

{
  "additional_name_formats": [
    {
      "id": "32",
      "configuration_id": "28",
      "constituent_id": "280",
      "custom_format": false,
      "formatted_name": "Robert and Wendy",
      "type": "Informal Salutation"
    },
    {
      "id": "33",
      "configuration_id": "2",
      "constituent_id": "280",
      "custom_format": false,
      "formatted_name": "Dr. Robert C. Hernandez and↵* Mrs. Wendy Hernandez",
      "type": "Annual Report"
    },
    {
      "id": "34",
      "configuration_id": "6",
      "constituent_id": "280",
      "custom_format": false,
      "formatted_name": "Dr. Robert C. Hernandez",
      "type": "Board Addressee"
    },
    {
      "id": "35",
      "configuration_id": "21",
      "constituent_id": "280",
      "custom_format": false,
      "formatted_name": "Dr. Hernandez",
      "type": "Board Salutation"
    },
    {
      "id": "36",
      "configuration_id": "30",
      "constituent_id": "280",
      "custom_format": false,
      "formatted_name": "Robert",
      "type": "Informal Board Salutation"
    },
    {
      "id": "37",
      "configuration_id": "24",
      "constituent_id": "280",
      "custom_format": false,
      "formatted_name": "Mrs. Hernandez",
      "type": "Spouse Salutation"
    },
    {
      "id": "38",
      "configuration_id": "45",
      "constituent_id": "280",
      "custom_format": false,
      "formatted_name": "Dr. Robert Hernandez and Guest",
      "type": "Invitation Mailing"
    },
    {
      "id": "225",
      "configuration_id": "1",
      "constituent_id": "280",
      "custom_format": false,
      "formatted_name": "Dr. and Mrs. Robert C. Hernandez, Class of 1987",
      "type": "Alumni Mailing"
    }
  ],
  "primary_addressee": {
    "id": "778BD6D0-AA44-4C45-B9DC-E872E934A103_280",
    "configuration_id": "6",
    "constituent_id": "280",
    "custom_format": false,
    "formatted_name": "Dr. Robert C. Hernandez",
    "primary_type": "Addressee"
  },
  "primary_salutation": {
    "id": "D17C0B9C-BADE-4A9E-8CE6-85ADA93C21EE_280",
    "configuration_id": "16",
    "constituent_id": "280",
    "custom_format": false,
    "formatted_name": "Dr. and Mrs. Hernandez",
    "primary_type": "Salutation"
  }
}
{
  "description": "All name formats associated with the constituent. This includes both primary addressee and salutation, as well as a list of additional standard name formats.",
  "type": "object",
  "properties": {
    "additional_name_formats": {
      "description": "The additional name formats of the constituent.",
      "type": "array",
      "items": {
        "description": "Name formats define how to address constituents in communications. How you refer to individuals sets the tone of your communications with them and how well they receive your interactions.",
        "type": "object",
        "properties": {
          "id": {
            "description": "The immutable system record ID of the name format.",
            "type": "string"
          },
          "configuration_id": {
            "description": "The name format configuration identifier.",
            "type": "string"
          },
          "constituent_id": {
            "description": "The immutable system record ID of the constituent associated with the name format.",
            "type": "string"
          },
          "custom_format": {
            "description": "Whether the name format uses a custom format.",
            "type": "boolean"
          },
          "formatted_name": {
            "description": "The name format formatted name.",
            "type": "string"
          },
          "type": {
            "description": "The name format type. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListNameFormatTypes\"><b>Addr/Sal Types</b></a> table.",
            "type": "string"
          }
        },
        "x-display-name": "Name format",
        "x-display-id": "NameFormat"
      }
    },
    "primary_addressee": {
      "description": "Addressees determine how the name appears with a mailing address, such as in an address block or on envelopes or mailing labels.",
      "type": "object",
      "properties": {
        "id": {
          "description": "The immutable system record ID of the primary name format.",
          "type": "string"
        },
        "configuration_id": {
          "description": "The primary name format configuration identifier.",
          "type": "string"
        },
        "constituent_id": {
          "description": "The immutable system record ID of the constituent associated with the primary name format.",
          "type": "string"
        },
        "custom_format": {
          "description": "Whether the primary name format uses a custom format.",
          "type": "boolean"
        },
        "formatted_name": {
          "description": "The primary name format formatted name.",
          "type": "string"
        },
        "primary_type": {
          "description": "The primary name format primary type.",
          "enum": [
            "Addressee",
            "Salutation"
          ],
          "type": "string"
        }
      },
      "x-display-name": "Primary name format",
      "x-display-id": "PrimaryNameFormat"
    },
    "primary_salutation": {
      "description": "Salutations determine how the name appears as a greeting within a letter or email message.",
      "type": "object",
      "properties": {
        "id": {
          "description": "The immutable system record ID of the primary name format.",
          "type": "string"
        },
        "configuration_id": {
          "description": "The primary name format configuration identifier.",
          "type": "string"
        },
        "constituent_id": {
          "description": "The immutable system record ID of the constituent associated with the primary name format.",
          "type": "string"
        },
        "custom_format": {
          "description": "Whether the primary name format uses a custom format.",
          "type": "boolean"
        },
        "formatted_name": {
          "description": "The primary name format formatted name.",
          "type": "string"
        },
        "primary_type": {
          "description": "The primary name format primary type.",
          "enum": [
            "Addressee",
            "Salutation"
          ],
          "type": "string"
        }
      },
      "x-display-name": "Primary name format",
      "x-display-id": "PrimaryNameFormat"
    }
  },
  "x-display-name": "Name format summary",
  "x-display-id": "NameFormatSummary"
}

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 name format summary.

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}/nameformats/summary"
-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/constituents/{constituent_id}/nameformats/summary?" + 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}/nameformats/summary");


            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/constituents/{constituent_id}/nameformats/summary?" + $.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}/nameformats/summary";
    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/constituents/{constituent_id}/nameformats/summary');
$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/constituents/{constituent_id}/nameformats/summary?%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/constituents/{constituent_id}/nameformats/summary?%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}/nameformats/summary')

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 API team? Please visit us on the SKY API Community!