Form API enables you to query and modify form-specific data. Each published form has a dedicated service to read data from and write data to PerfectForms™ form instances. This form-specific service is at the URL you receive from the form’s link dialog. Each form has its own service. For example: "/api/forms/rZtAg7gAggAAcgQM_My_Form.asmx"
Storing Form Instance IDs
Each completed instance of any form is called a form instance and it has its own system unique ID. If you plan to reference form instances from other systems and applications, it is important that you store the form instance ID. This will then allow you to retrieve or update data for this form instance using this form instance ID.
Once a form instance ID is created, it will remain fixed and will not change. This is not the same as the sequential number that is accessible from the Special section of the Formula and Condition Editor.
Any function that takes instance ID as a parameter also uses this type of form instance ID.
Data Validation Responsibilities
When using the API, all data must be validated by the developer. If, for example, you pass an invalid e-mail address into a Text field which is set to be e-mail format, it will be accepted by the API just as it was sent.
Republishing a Form Changes the Web Service Link
When you change your form and republish it, PerfectForms™ will change the Web Service link provided and you will need to update your project to call the new URL.
API-related Naming Constraints on Form Objects
PerfectForms™ imposes some naming constraints. These constraints are as follows:
| • | Controls may have the same full name when their page and group containers are included. |
| • | Page names may not start with a digit. |
| • | No two list elements in a list type field can have the same name or code (lists elements are radio buttons in radio button groups, list items in a drop-down list, list items in normal lists and items in a ranking field). |
Updated: 06/12/2011
Page url:
http://www.perfectforms.com/Documentation/manual/html/?fg_form_api.htm
PerfectForms™ -- forms software, workflow software, and business process management