Communication Preference

This API manages constituent communication preference information and related entities such as constituent consent.

GET

Constituent solicit code list (Single constituent)

Returns a list of solicit codes for the specified 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 solicit codes for.

limit integer

Set this parameter to return only the specified number of records in the response. Defaults to return all records.

skip integer

Set this parameter to skip the specified number of records in the response. Defaults to skip no records.

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 collection of constituent solicit codes.

{
  "count": 2,
  "value": [
    {
      "id": "1",
      "constituent_id": "280",
      "end_date": "2019-04-03T04:00:00Z",
      "solicit_code": "Do not call on weekends",
      "start_date": "2013-04-03T04:00:00Z"
    },
    {
      "id": "43",
      "constituent_id": "280",
      "end_date": "2017-04-04T04:00:00Z",
      "solicit_code": "Unavailable between 3-5pm on business days",
      "start_date": "2016-12-04T05:00:00Z"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "count": {
      "type": "integer",
      "description": "The number of constituent solicit codes in the list.",
      "format": "int32",
      "readOnly": true
    },
    "value": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The immutable system record ID of the constituent solicit code.",
            "nullable": true
          },
          "constituent_id": {
            "type": "string",
            "description": "The immutable system record ID of the constituent associated with the solicit code.",
            "nullable": true
          },
          "end_date": {
            "type": "string",
            "description": "The end date of the solicit code. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
            "format": "date-time",
            "nullable": true
          },
          "solicit_code": {
            "type": "string",
            "description": "Communication instructions and/or restrictions for a constituent. Available values can be obtained from the <a href=\"https://developer.sky.blackbaud.com/docs/services/communication-preference/operations/ListSolicitCodes\">Solicit Codes List</a>.",
            "nullable": true
          },
          "start_date": {
            "type": "string",
            "description": "The start date of the solicit code. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
            "format": "date-time",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Solicit codes provide guidance on how to contact constituents. These rules describe instructions and restrictions about when to reach out to constituents and how to tailor communications to honor their requests."
      },
      "description": "The set of constituent solicit codes included in the response.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "A collection of constituent solicit codes."
}

Response 400 Bad Request

Returned when constituent_id is not in the appropriate format.

[
  {
    "message": "The request body is not in the appropriate format.",
    "error_name": "BadRequest",
    "error_code": 400,
    "raw_message": "The request body is not in the appropriate format."
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "description": "The message of the service error with any string arguments replaced.",
        "nullable": true
      },
      "error_name": {
        "type": "string",
        "description": "The name of the service error.",
        "nullable": true
      },
      "error_code": {
        "type": "integer",
        "description": "Code number of the service error.",
        "format": "int32"
      },
      "raw_message": {
        "type": "string",
        "description": "The raw message of the service error. This message may contain string replacement arguments (ie: {0}, {1}, etc) that map to the 'error_args' property and will be replaced when you get the full message from the 'message' property.",
        "nullable": true
      },
      "error_args": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "A list of arguments to be replaced in the raw message. Useful for when the message needs to be localized.",
        "nullable": true
      }
    },
    "additionalProperties": false,
    "description": "Base service error contract."
  },
  "x-apim-inline": true
}

Response 403 Forbidden

Returned when the user does not have rights to view the constituent or solicit codes.

[
  {
    "message": "The user does not have permission to create a record.",
    "error_name": "Forbidden",
    "error_code": 403,
    "raw_message": "The user does not have permission to create a record."
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "description": "The message of the service error with any string arguments replaced.",
        "nullable": true
      },
      "error_name": {
        "type": "string",
        "description": "The name of the service error.",
        "nullable": true
      },
      "error_code": {
        "type": "integer",
        "description": "Code number of the service error.",
        "format": "int32"
      },
      "raw_message": {
        "type": "string",
        "description": "The raw message of the service error. This message may contain string replacement arguments (ie: {0}, {1}, etc) that map to the 'error_args' property and will be replaced when you get the full message from the 'message' property.",
        "nullable": true
      },
      "error_args": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "A list of arguments to be replaced in the raw message. Useful for when the message needs to be localized.",
        "nullable": true
      }
    },
    "additionalProperties": false,
    "description": "Base service error contract."
  },
  "x-apim-inline": true
}

Response 404 Not Found

Returned when the specified constituent cannot be found.

[
  {
    "message": "The requested record was not found.",
    "error_name": "NotFound",
    "error_code": 404,
    "raw_message": "The requested record was not found."
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "description": "The message of the service error with any string arguments replaced.",
        "nullable": true
      },
      "error_name": {
        "type": "string",
        "description": "The name of the service error.",
        "nullable": true
      },
      "error_code": {
        "type": "integer",
        "description": "Code number of the service error.",
        "format": "int32"
      },
      "raw_message": {
        "type": "string",
        "description": "The raw message of the service error. This message may contain string replacement arguments (ie: {0}, {1}, etc) that map to the 'error_args' property and will be replaced when you get the full message from the 'message' property.",
        "nullable": true
      },
      "error_args": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "A list of arguments to be replaced in the raw message. Useful for when the message needs to be localized.",
        "nullable": true
      }
    },
    "additionalProperties": false,
    "description": "Base service error contract."
  },
  "x-apim-inline": true
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.sky.blackbaud.com/commpref/v1/constituents/{constituent_id}/constituentsolicitcodes?limit={integer}&skip={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["limit"] = "{integer}";
            queryString["skip"] = "{integer}";
            var uri = "https://api.sky.blackbaud.com/commpref/v1/constituents/{constituent_id}/constituentsolicitcodes?" + 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/commpref/v1/constituents/{constituent_id}/constituentsolicitcodes");

            builder.setParameter("limit", "{integer}");
            builder.setParameter("skip", "{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
            "limit": "{integer}",
            "skip": "{integer}",
        };

        $.ajax({
            url: "https://api.sky.blackbaud.com/commpref/v1/constituents/{constituent_id}/constituentsolicitcodes?" + $.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/commpref/v1/constituents/{constituent_id}/constituentsolicitcodes";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"limit={integer}",
                         @"skip={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/commpref/v1/constituents/{constituent_id}/constituentsolicitcodes');
$url = $request->getUrl();

$headers = array(
    // Request headers
   'Bb-Api-Subscription-Key' => '{subscription key}',
   'Authorization' => 'Bearer {access token}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'limit' => '{integer}',
    'skip' => '{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
    'limit': '{integer}',
    'skip': '{integer}',
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/commpref/v1/constituents/{constituent_id}/constituentsolicitcodes?%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
    'limit': '{integer}',
    'skip': '{integer}',
})

try:
    conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/commpref/v1/constituents/{constituent_id}/constituentsolicitcodes?%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/commpref/v1/constituents/{constituent_id}/constituentsolicitcodes')

query = URI.encode_www_form({
    # Request parameters
    'limit' => '{integer}',
    'skip' => '{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

Have a question? See a problem with our docs? Want to engage with the SKY Developer team? Please visit us on the SKY Developer Community!