Blackbaud AppFX Server HTTP Endpoint Reference


The endpoints listed below all expose various services that are accessible over HTTP.

Click the link for each endpoint for documentation on using that endpoint.

Name url Description
Blackbaud AppFx Web Service /appfxwebservice.asmx Single SOAP endpoint for accessing all application features.
Business Operations Services /vpp/bizops/dbcatalogs.aspx Individual SOAP endpoints for accessing application specific business operations.
RSS Feed Service /RSSFeed.ashx Provides RSS feeds over application datalists.
KPI REST Service /KpiEndpoint.ashx Services related to KPI instances.
KPI Dashboard HTML page /KpiDashboard.aspx Renders the user's KPI dashboard to HTML to be displayed in a browser.
Business Process Invoke REST service. /BusinessProcessInvoke.ashx Initiates the launching of a pre-defined business process parameter set.
Service Infomation Xml Document. /util/ServiceInfo.ashx Returns information about the version of the AppFx server and database.
Available Database list Xml Document. /util/GetAvailableDatabases.ashx Returns the list of available databases for the services.
Catalog Image Service. /browser/clientbin/images/catalogimage.ashx Returns an embedded image stored in a catalog assembly.
DataForm File Upload Service. /Upload/FileUpload.ashx Accepts a file via an HTTP POST in conjunction with a DataFormSaveRequest.
DataForm File Download Service. /Download/FileDownload.ashx Sends a file as a BLOB that is the data value for a DataForm.
Custom File Download Service. /Download/CustomFileDownload.ashx Sends down bytes via a class inheriting from Blackbaud.AppFx.Server.AppCatalog.AppCustomFileDownLoadProcessor.
Catalog Item Loader Service. /util/LoadCatalogItem.ashx Loads an xml catalog item (spec) from a catalog assembly or xml file in the bin\xmlspecs folder on the server.
DataList Service. /util/DataList.ashx Fetch data from a datalist in one of several formats.
Available Database List Web Service /DBList.asmx SOAP endpoint for getting the list of available databases as defined in web.config. The list corresponds to the list of databases that appear in the application login dialog.

Other links:

Administrative utilities
Client Application Start Page