Connecting to Formsite

To use the Formsite Profile, set the Profile property of the CData API Driver to the path of the Formsite profile, along with the required connection properties detailed below. Once configured, you can execute SQL queries to access data from any of the Formsite tables.

Authentication

Formsite uses API key authentication to secure access to your form data and management features. Authentication requires an API key generated from your Formsite account dashboard.

Obtaining Your API Key

To get your API key:

1. Log in to your Formsite account
2. Navigate to the Admin Portal
3. Access the API settings or integration settings section
4. Generate a new API key or copy your existing API key
5. Set the APIKey connection property with your API key value

Required Connection Properties

• APIKey: Your Formsite API key obtained from the Admin Portal (required)
• ServerNumber: Formsite server number (e.g., 18 for fs18.Formsite.com) (required)
• UserDirectory: Your Formsite user directory path for API calls (required)

Available Tables

The Formsite API Profile provides access to comprehensive form management and data collection capabilities:

• Forms - Retrieve all forms in your account with metadata including form status, publication settings, statistics, and configuration details.
• FormItems - Access detailed information about form elements, fields, and structure for specific forms including labels, positions, and field hierarchies.
• FormResults - Query form submission data and responses with comprehensive filtering options by date, status, and user information.

Connection Examples

Basic Connection String

Profile=C:\profiles\Formsite.apip;APIKey=your_api_key_here;ServerNumber=18;UserDirectory=your_user_directory;

Alternative Connection String Format

Profile=C:\profiles\Formsite.apip;ProfileSettings='APIKey=your_api_key_here;ServerNumber=18;UserDirectory=your_user_directory';

Usage Examples

Form Management

List all forms:

SELECT Id, Name, State, StatsResultsCount FROM Forms

Form Structure Analysis

Get form fields and structure:

SELECT Position, Label, Id FROM FormItems
WHERE FormId = 'your_form_id'

Submission Data Retrieval

Get recent form submissions:

SELECT Id, DateFinish, ResultStatus, Items FROM FormResults
WHERE FormId = 'your_form_id'
  AND DateFinish > '2024-01-01'

Rate Limits

Formsite API has rate limits of 50 requests per minute and 10,000 requests per day. Monitor your usage to stay within these limits. Consider implementing caching strategies for frequently accessed data.

Server Configuration

Formsite uses different server endpoints based on your account. The ServerNumber property corresponds to your Formsite server (e.g., fs18.Formsite.com uses ServerNumber=18). Your UserDirectory property represents your account's directory path. Both are required for proper API endpoint construction.

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

---

Property	Description
APIKey	The API Key from your Formsite account.
AuthScheme	The scheme used for authentication. Accepted entry is APIKey. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT
ServerNumber	The Formsite server number for your account.
UserDirectory	The user directory path for your Formsite account.