get_form
Retrieves user generated content
Description
This fuction returns a user generated xform based on parameters passed in.
Parameters
- action
- get_form
- fid
- ID of the XForm definition.
- docid
- The document ID scope to use quering XForms.
- name
- User form name like profile, preference.
- parent
- Name of the parent form to which the form replies for the comment. If "ROOT" is provided, then only forms which are a root (parent = '') are returned.
- type
- Form type. It can be system, floating or document.
- lang
- The language scope to use when querying XForms (such as "en", or "en-US").
- user
- User name of the form being requested.
- ancestor
- Name of the ancestor form to which the form replies for the comment
- skin
- The skin name from which to load the UI resource (HTML, CSS, image, JavaScript).
Example URL
http://<host>:<port>/<context>/web/xforms.xql?action=get_form&fid=<value>&docid=<value>&name=<value>&parent=<value>&type=<value>&lang=<value>&user=<value>&ancestor=<value>&skin=<value>
Successful Result
If user does not have permission, it will display a permission denied page, otherwise when success, it will return retrieved xform. If fail, it will display an error page.
Failed Result
If user does not have permission, it will display a permission denied page, all other failure cases, it will display an error page.