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 for whom information is to be retrieved. |
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 constituent entity.
{
"id": "280",
"address": {
"id": "757",
"address_lines": "410 17th Street",
"city": "Denver",
"constituent_id": "280",
"country": "United States",
"county": "Denver",
"do_not_mail": false,
"formatted_address": "410 17th Street\r\nDenver, CO 80202-4402",
"postal_code": "80202-4402",
"preferred": true,
"state": "CO",
"type": "Home"
},
"age": 54,
"birthdate": {
"d": 14,
"m": 3,
"y": 1961
},
"date_added": "1999-05-20T18:57:55Z",
"date_modified": "2016-07-14T04:13:51.2167803Z",
"deceased": false,
"email": {
"id": "283",
"address": "robertcarloshernandez@gmail.com",
"do_not_email": false,
"inactive": false,
"primary": false,
"type": "Email"
},
"first": "Robert",
"fundraiser_status": "Active",
"gender": "Male",
"gives_anonymously": false,
"inactive": false,
"is_constituent": true,
"last": "Hernandez",
"lookup_id": "96",
"middle": "Carlos",
"name": "Dr. Robert C. Hernandez",
"online_presence": {
"id": "811",
"address": "http://www.myspace.com/drbobhernandez",
"inactive": false,
"primary": false,
"type": "Web address"
},
"phone": {
"id": "95",
"do_not_call": false,
"inactive": false,
"number": "(303)-997-3301",
"primary": false,
"type": "Home"
},
"preferred_name": "Bob",
"spouse": {
"id": "410",
"first": "Wendy",
"last": "Hernandez",
"is_head_of_household": false
},
"title": "Dr.",
"type": "Individual",
"import_id": "1234-56-789101"
}{
"description": "Constituents are the individuals and organizations who support your organization by contributing time, money, and resources. The constituent entity stores information about donors, prospects, volunteers, general supporters, and more.",
"type": "object",
"properties": {
"id": {
"description": "The immutable system record ID for the constituent. This is not the same as the user-definable constituent identifier, which is stored in the <code>lookup_id</code>.",
"type": "string"
},
"address": {
"description": "The constituent's preferred address.",
"type": "object",
"properties": {
"id": {
"description": "The immutable system record ID of the address.",
"type": "string"
},
"address_lines": {
"description": "The address lines.",
"type": "string"
},
"city": {
"description": "The city of the address.",
"type": "string"
},
"constituent_id": {
"description": "The immutable system record ID of the constituent associated with the address.",
"type": "string"
},
"country": {
"description": "The country of the address.",
"type": "string"
},
"county": {
"description": "The county of the address.",
"type": "string"
},
"date_added": {
"format": "date-time",
"description": "The date when the address 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 address 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
},
"do_not_mail": {
"description": "Indicates whether the constituent requests not to be contacted at this address.",
"type": "boolean"
},
"end": {
"format": "date-time",
"description": "The date when the constituent ceased to reside at this address. 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
},
"formatted_address": {
"description": "This computed field retrieves the formatted address in the configured format of the country.",
"type": "string"
},
"inactive": {
"description": "This computed field indicates that the address is active if the current date is before any <code>end</code> date.",
"type": "boolean"
},
"postal_code": {
"description": "The postal code of the address.",
"type": "string"
},
"preferred": {
"description": "Indicates whether this is the constituent's preferred address.",
"type": "boolean"
},
"seasonal_end": {
"description": "The time of the year ceases to reside at this address.",
"type": "object",
"properties": {
"d": {
"format": "int32",
"description": "The day in the fuzzy date.",
"type": "integer"
},
"m": {
"format": "int32",
"description": "The month in the fuzzy date.",
"type": "integer"
},
"y": {
"format": "int32",
"description": "The year in the fuzzy date.",
"type": "integer"
}
},
"x-display-name": "Fuzzy date",
"x-display-id": "FuzzyDate"
},
"seasonal_start": {
"description": "The time of year that the constituent begins residing at this address.",
"type": "object",
"properties": {
"d": {
"format": "int32",
"description": "The day in the fuzzy date.",
"type": "integer"
},
"m": {
"format": "int32",
"description": "The month in the fuzzy date.",
"type": "integer"
},
"y": {
"format": "int32",
"description": "The year in the fuzzy date.",
"type": "integer"
}
},
"x-display-name": "Fuzzy date",
"x-display-id": "FuzzyDate"
},
"start": {
"format": "date-time",
"description": "The date when the constituent began residing at this address. 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
},
"state": {
"description": "The state of the address.",
"type": "string"
},
"suburb": {
"description": "The suburb of the address.",
"type": "string"
},
"type": {
"description": "The address type. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListAddressTypes\"><b>Address Types</b></a> table.",
"type": "string"
}
},
"x-display-name": "Address",
"x-display-id": "Address",
"x-additional-info": "\r\n<p>Some <b>Address</b> entity properties include international address support.</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><strong>Property</strong></th>\r\n <th><strong>United States</strong></th>\r\n <th><strong>Canada</strong></th>\r\n <th><strong>United Kingdom</strong></th>\r\n <th><strong>Australia</strong></th>\r\n <th><strong>New Zealand</strong></th>\r\n </tr>\r\n </thead>\r\n <tbody>\r\n <tr>\r\n <td>address_lines</td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n </tr>\r\n <tr>\r\n <td>city</td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n <td><i class=\"fa fa-check\"></i>*</td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n </tr>\r\n <tr>\r\n <td>suburb</td>\r\n <td></td>\r\n <td></td>\r\n <td></td>\r\n <td></td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n </tr>\r\n <tr>\r\n <td>state</td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n <td><i class=\"fa fa-check\"></i>!</td>\r\n <td></td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n <td></td>\r\n </tr>\r\n <tr>\r\n <td>postal_code</td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n </tr>\r\n <tr>\r\n <td>county</td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n <td></td>\r\n <td></td>\r\n </tr>\r\n <tr>\r\n <td>country</td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n <td><i class=\"fa fa-check\"></i></td>\r\n </tr>\r\n </tbody>\r\n </table>\r\n</div>\r\n\r\n<div class=\"footnotes\">\r\n <p class=\"footnote\">* <b>Australia</b> — For <code>GET</code> operations, the <code>city</code> property returns city or suburb data. For <code>POST</code> and <code>PATCH</code> operations, you can use either the <code>suburb</code> or <code>city</code> properties, but not both. An error occurs if you provide values for both properties.</p>\r\n <p class=\"footnote\">! <b>Canada</b> — Use the <code>state</code> property to track provinces.</p>\r\n</div>"
},
"age": {
"format": "int32",
"description": "This computed field calculates the constituent's age based on the <code>birthdate</code> property. For individuals only.",
"type": "integer"
},
"birthdate": {
"description": "The constituent's birthdate. For individuals only.",
"type": "object",
"properties": {
"d": {
"format": "int32",
"description": "The day in the fuzzy date.",
"type": "integer"
},
"m": {
"format": "int32",
"description": "The month in the fuzzy date.",
"type": "integer"
},
"y": {
"format": "int32",
"description": "The year in the fuzzy date.",
"type": "integer"
}
},
"x-display-name": "Fuzzy date",
"x-display-id": "FuzzyDate"
},
"date_added": {
"format": "date-time",
"description": "The date when the constituent 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 constituent 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
},
"deceased": {
"description": "Indicates whether the constituent is deceased. For individuals only.",
"type": "boolean"
},
"deceased_date": {
"description": "The date when the constituent died. For individuals only.",
"type": "object",
"properties": {
"d": {
"format": "int32",
"description": "The day in the fuzzy date.",
"type": "integer"
},
"m": {
"format": "int32",
"description": "The month in the fuzzy date.",
"type": "integer"
},
"y": {
"format": "int32",
"description": "The year in the fuzzy date.",
"type": "integer"
}
},
"x-display-name": "Fuzzy date",
"x-display-id": "FuzzyDate"
},
"email": {
"description": "The constituent's primary email address, or the constituent's first active email address if no active email address is marked as primary.",
"type": "object",
"properties": {
"id": {
"description": "The immutable system record ID of the email address.",
"type": "string"
},
"address": {
"description": "The email address.",
"type": "string"
},
"constituent_id": {
"description": "The immutable system record ID of the constituent associated with the email address.",
"type": "string"
},
"date_added": {
"format": "date-time",
"description": "The date when the email address 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 email address 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
},
"do_not_email": {
"description": "Indicates whether the constituent requests not to be contacted at this email address.",
"type": "boolean"
},
"inactive": {
"description": "Indicates whether the email address is inactive.",
"type": "boolean"
},
"primary": {
"description": "Indicates whether this is the constituent's primary email address.",
"type": "boolean"
},
"type": {
"description": "The type of email address. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListEmailAddressTypes\"><b>Phone Types</b></a> table.",
"type": "string"
}
},
"x-display-name": "Email address",
"x-display-id": "EmailAddress"
},
"first": {
"description": "The constituent's first name. For individuals only.",
"type": "string"
},
"former_name": {
"description": "The constituent's former name. For individuals only.",
"type": "string"
},
"fundraiser_status": {
"description": "Indicates whether the constituent is a fundraiser. For individuals only.",
"enum": [
"Active",
"Inactive",
"None"
],
"type": "string"
},
"gender": {
"description": "The constituent's gender. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListGenders\"><b>Gender</b></a> table. This property defaults to <i>unknown</i> if no value is provided. For individuals only.",
"type": "string"
},
"gives_anonymously": {
"description": "Indicates whether the constituent gives anonymously.",
"type": "boolean"
},
"inactive": {
"description": "Indicates whether the constituent is inactive.",
"type": "boolean"
},
"last": {
"description": "The constituent's last name. For individuals only.",
"type": "string"
},
"lookup_id": {
"description": "The user-defined identifier for the constituent.",
"type": "string"
},
"marital_status": {
"description": "The constituent's marital status. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListMaritalStatuses\"><b>Marital Status</b></a> table. For individuals only.",
"type": "string"
},
"middle": {
"description": "The constituent's middle name. For individuals only.",
"type": "string"
},
"name": {
"description": "If the constituent's <code>type</code> is <i>Individual</i>, this computed field indicates the full name of the constituent based on the target organization’s display name settings. If the <code>type</code> is <i>Organization</i>, this is the organization's name.",
"type": "string"
},
"online_presence": {
"description": "The constituent's primary online presence, or the constituent's first active online presence if no active online presence is marked as primary.",
"type": "object",
"properties": {
"id": {
"description": "The immutable system record ID of the online presence.",
"type": "string"
},
"address": {
"description": "The web address for the online presence.",
"type": "string"
},
"constituent_id": {
"description": "The immutable system record ID of the constituent associated with the online presence.",
"type": "string"
},
"date_added": {
"format": "date-time",
"description": "The date when the online presence 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 online presence 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
},
"inactive": {
"description": "Indicates whether the online presence is inactive.",
"type": "boolean"
},
"primary": {
"description": "Indicates whether this is the constituent's primary online presence.",
"type": "boolean"
},
"type": {
"description": "The online presence type. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListOnlinePresenceTypes\"><b>Phone Types</b></a> table.",
"type": "string"
}
},
"x-display-name": "Online presence",
"x-display-id": "OnlinePresence"
},
"phone": {
"description": "The constituent's primary phone, or the constituent's first active phone if no active phone is marked as primary.",
"type": "object",
"properties": {
"id": {
"description": "The immutable system record ID of the phone.",
"type": "string"
},
"constituent_id": {
"description": "The immutable system record ID of the constituent associated with the phone.",
"type": "string"
},
"date_added": {
"format": "date-time",
"description": "The date when the phone 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 phone 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
},
"do_not_call": {
"description": "Indicates whether the constituent requests not to be contacted at this number.",
"type": "boolean"
},
"inactive": {
"description": "Indicates whether the phone is inactive.",
"type": "boolean"
},
"number": {
"description": "The phone number.",
"type": "string"
},
"primary": {
"description": "Indicates whether this is the constituent's primary phone.",
"type": "boolean"
},
"type": {
"description": "The phone type. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListPhoneTypes\"><b>Phone Types</b></a> table.",
"type": "string"
}
},
"x-display-name": "Phone",
"x-display-id": "Phone"
},
"preferred_name": {
"description": "The constituent's preferred name. For individuals only.",
"type": "string"
},
"spouse": {
"description": "This computed field retrieves information about the constituent's spouse using the constituent's <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListConstituentRelationshipsSingleConstituent\">relationships</a>. For individuals only.",
"type": "object",
"properties": {
"id": {
"description": "The immutable system record ID of the spouse.",
"type": "string"
},
"first": {
"description": "The spouse's first name.",
"type": "string"
},
"last": {
"description": "The spouse's last name.",
"type": "string"
},
"is_head_of_household": {
"description": "Indicates whether the spouse is the head household. Only applies to constituent spouses.",
"type": "boolean"
}
},
"x-display-name": "Spouse",
"x-display-id": "Spouse"
},
"suffix": {
"description": "The constituent's primary suffix. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListSuffixes\"><b>Suffixes</b></a> table. For individuals only.",
"type": "string"
},
"suffix_2": {
"description": "The constituent's secondary suffix. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListSuffixes\"><b>Suffixes</b></a> table. For individuals only.",
"type": "string"
},
"title": {
"description": "The constituent's primary title. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListTitles\"><b>Titles</b></a> table. For individuals only.",
"type": "string"
},
"title_2": {
"description": "The constituent's secondary title. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListTitles\"><b>Titles</b></a> table. For individuals only.",
"type": "string"
},
"type": {
"description": "The type of constituent. Available values are <i>Individual</i> and <i>Organization</i>.",
"enum": [
"Individual",
"Organization"
],
"type": "string"
},
"birthplace": {
"description": "The birthplace of the constituent. For individuals only.",
"type": "string"
},
"ethnicity": {
"description": "The ethnicity of the constituent. For individuals only.",
"type": "string"
},
"income": {
"description": "The income for the constituent. For individuals only.",
"type": "string"
},
"religion": {
"description": "The religion of the constituent. For individuals only.",
"type": "string"
},
"industry": {
"description": "The industry of the constituent. For organizations only.",
"type": "string"
},
"matches_gifts": {
"description": "Indicates if the constituent matches gifts. For organizations only.",
"type": "boolean"
},
"matching_gift_per_gift_min": {
"description": "The minimum matching gift per gift for the constituent. For organizations only.",
"type": "object",
"properties": {
"value": {
"format": "double",
"description": "The monetary value.",
"type": "number"
}
}
},
"matching_gift_per_gift_max": {
"description": "The maximum matching gift per gift for the constituent. For organizations only.",
"type": "object",
"properties": {
"value": {
"format": "double",
"description": "The monetary value.",
"type": "number"
}
}
},
"matching_gift_total_min": {
"description": "The minimum matching gift total for the constituent. For organizations only.",
"type": "object",
"properties": {
"value": {
"format": "double",
"description": "The monetary value.",
"type": "number"
}
}
},
"matching_gift_total_max": {
"description": "The maximum matching gift total for the constituent. For organizations only.",
"type": "object",
"properties": {
"value": {
"format": "double",
"description": "The monetary value.",
"type": "number"
}
}
},
"matching_gift_factor": {
"format": "double",
"description": "The matching gift factor for the constituent. For organizations only.",
"type": "number"
},
"matching_gift_notes": {
"description": "The matching gift notes for the constituent. For organizations only.",
"type": "string"
},
"num_employees": {
"format": "int32",
"description": "The number of employees for the constituent. For organizations only.",
"type": "integer"
},
"is_memorial": {
"description": "Indicates whether the constituent is for honor/memorial.",
"type": "boolean"
},
"is_solicitor": {
"description": "Indicates whether the constituent is a solicitor.",
"type": "boolean"
},
"no_valid_address": {
"description": "Indicates whether the constituent does not have a valid address.",
"type": "boolean"
},
"receipt_type": {
"description": "The receipt type of the constituent.",
"enum": [
"One receipt per gift",
"Consolidated receipts"
],
"type": "string"
},
"target": {
"description": "The target of the constituent.",
"type": "string"
},
"requests_no_email": {
"description": "Indicates whether the constituent requests no email.",
"type": "boolean"
},
"import_id": {
"description": "The import id for the constituent.",
"type": "string"
},
"is_constituent": {
"description": "Flag indicating whether or not this individual or organization is a constituent",
"type": "boolean"
}
},
"x-display-name": "Constituent",
"x-display-id": "Constituent_01"
}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 constituent.
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}"
-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}?" + 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}");
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}?" + $.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}";
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}');
$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}?%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}?%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}')
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