OpenForms provides a series of SOAP-based Web Services to perform the most common tasks available through the environment. This includes automatically triggering print jobs with pre-filled data and querying the forms database for captured data.

The intended audience for the web services is software developers wishing to integrate their systems and products with OpenForms. Using the services normally requires that you have access to a software development environment capable of interating with them (e.g. such as Java or .NET), although other options may also exist.

Forms Web Service

https://<servername>/WebServices/Magicomm.IForms/Magicomm.IForms.WebService.Forms.FormService.svc?singleWsdl

The Forms Web Service enables the caller to query and retrieve data from OpenForms. The following operations are available:

1) Search

The Search method allows you to query the forms database for data matching a particular criteria. For example, you could search for all newly-submitted forms, or search for all forms where the Title field has been entered as “Mr”.

The results of the search is a Data Table containing the list of forms matching the criteria. Note that the table only contains a subset of the captured information such as the Owner of the document and the date it was posted. You can also specify additional capture fields to return in the call to Search.

2) SetFormStatus

This method allows you to change the status of a single form. Typically you can use this method in conjunction with Search to mark forms that you do not wish to receive again. For example, you could search for all “COMPLETED” forms and then mark each form as “EXPORTED” when you have received them.

3) GetCurrentFormVersion

This method enables you to export a form in a specified format. For example, if you wish to receive a PDF copy of the form you can specify this as the export format. You can specify any number of formats to export in the same call.

This method also allows you to export all of the data captured on a form using any of the installed export formats. Typically you could use the Schema-less XML format to retrieve this data.

4) GetFormats

GetFormats is a utility method that will list all of the installed export formats available. These formats can be specified in a call to GetCurrentFormVersion depending upon your requirements.

 

Forms Templates Web Service

https://<servername>/WebServices/Magicomm.IForms/Magicomm.IForms.WebService.Forms.FormTypeService.svc?singleWsdl

The Forms Web Service enables the caller to create and retrieve form templates from OpenForms. The following operations are available:

1) Search

The search method allows the caller to query available templates within the system. Filtering is possible, typically this is using the ‘name’ parameter to partially match template names within OpenForms.

The results of the search is a Data Table containing the list of forms matching the criteria. Note that the table only contains a subset of the template information such as the date it was created.

2) GetFormats

GetFormats is a utility method that will list all of the installed export formats available. These formats can be specified in a call to ExportFormType depending upon your requirements.

3) ExportFormType

This method enables you to export a form template in a specified format. For example, if you wish to receive an XML definition of the form you can specify this as the export format. You can specify any number of formats to export in the same call.

4) ImportFormType

This method enables you to create or update an existing form template.