Documentation Center

Load generic form dialog

Generic forms are stored and referenced by an instance ID, matched with a form name. This API call retrieves an XHTML interface that allows a user to create a new form, or edit an existing form. This XHTML interface includes the form's title, type, and instance ID as attributes of its top level element.

Example API call

/servlets3/wietmsd?id=1459152075302&book=s1000d_bike_41&collection=default&time=1459152073970&target=forms&action=form_dlg&form_type=genforms&form_name=SavedSearches

Parameters

ParameterDescription
targetforms
actionform_dlg
form_typeThis value is always genforms.
form_nameThe system identifier of the form type, such as SavedSearches, genform1, or template.
idA session ID that is valid for this collection and publication combination.
book The name of the publication, such as s1000d_bike_41.
collectionThe name of the collection that the publication is registered in, such as default.
timeTo prevent browser-side caching of data, especially with AJAX requests, it is important to make a URL unique. The most effective technique to accomplish this is to include a time parameter that is based on the time at which the call is made.

Returns

On success
A dynamically generated XHTML interface that allows the user to create a new form or edit an existing form. This XHTML instance is created by transforming the form's XML template (book_data/collection_name/publication_name/genforms/form_name/form_name.xml) using the form's XSL stylesheet (same location, form_name.xsl) and the generic genform.xsl in the genforms directory for the publication. The top level element of this XHTML return (usually a <div/>) includes the following attributes: @form_name, @form_type and @instance_name. If a form is being edited, then its values will be dynamically inserted into the form fields by the XSL transformation.
On failure
Returns nothing