#Overview#

The API cookbook samples demonstrate how to call individual features (ex: Contact Information Address List) via the Blackbaud CRM SOAP Web Service (AppFxWebService.asmx). The samples utilize twitter bootstrap 2.3.2 which provide a sleek, intuitive, and responsive front-end framework.

##Providing a Primary Key Guid for the Record Type ID## In order to retrieve the data, each sample typically takes an ID (Primary Key) value of a certain Record Type (Constituent, Address, etc.) in either an html input...

... and/or query string in the URL. Note in the example below how we provide a GUID Constituent ID within the query string in the URL. The GUID represents a primary key value for a constituent.

Ex: http://localhost:800/AddressList.php?ConstituentID=0030D1BA-4A49-44AB-A44C-F9E294CDE8C0

##Technologies##

The following technologies, languages, and libraries are used:

1. PHP
2. jQuery 1.8.3
3. Bootstrap 2.3.2
4. Bootstrap date time picker

###About Bootstrap###

Bootstrap is built to work best in the latest desktop and mobile browsers, meaning older browsers might display differently styled, though fully functional, renderings of certain components. The cookbook is geared toward modern browsers.

##Prerequisites##

1. You will need to Install and Configure PHP.
2. You will need an instance of Blackbaud CRM. Here are some installation instructions if you want to do a local install.
3. You will need domain/user name and password credentials. These credentials must be associated with an application user within Blackbaud CRM. The application user must have permission to use the feature(s) that the cookbook recipe is interacting with. See Authentication and Authorization.
4. Within helperfunctions.php you will need to provide the correct values for the following variables:

$wsdl - url to the BBEC web service end point wsdl document. See Locating the Endpoint. See getSoapClient() function within helperfunctions.php.

Ex: $wsdl = 'http://localhost/bbappfx/appfxwebservice.asmx?wsdl';

$userName - Domain\User credentials to access the web service using basic authentication. See Authentication and Authorization See getSoapClient() function within helperfunctions.php.

Ex: $userName = 'Domain\User Name';

$password - domain user password credentials to access the web service using basic authentication (See getSoapClient() function within helperfunctions.php

Ex:  $password = 'Password';

hardcoding your username and password into your PHP application is a terrible idea in practice. The cookbook is just for testing/example purposes

$database - the database to use. See function getClientAppInfo() within helperfunctions.php

Ex:  $database = 'BBInfinity';

##Related Resources##

• API Overview
• AppFxWebService.asmx
• Locating the Endpoint
• Authentication and Authorization

##Contributing##

Third-party contributions are how we keep the code samples great. We want to keep it as easy as possible to contribute changes that show others how to do cool things with Blackbaud SDKs and APIs. There are a few guidelines that we need contributors to follow.

For more information, see our canonical contributing guide in the Blackbaud CRM repo which provides detailed instructions, including signing the Contributor License Agreement.