delete_form
Delete xform.
Description
Delete a specified xform and its children.
Parameters
- action
- delete_form
- fid
- ID of the XForm definition.
- type
- Form type. It can be system, floating or document.
- docid
- The document ID scope to use quering XForms.
- name
- User form name like profile, preference.
Example URL
http://<host>:<port>/<context>/web/xforms.xql?action=delete_form&fid=<value>&type=<value>&docid=<value>&name=<value>
Successful Result
This function returns a standard API result element (<result status='SUCCESS' statusCode='0' message='Localized Message' messageKey='message.key'/>). A statusCode of 0 indicates a successful execution. Any other statusCode indicates a failure.
Failed Result
If user does not have the 'Manage Forms' permission, it will display pemission denied page. In the case of an error, this function returns a standard API result element with a non-zero statusCode (such as, <result status='FAIL' statusCode='200' message='Localized Failure Message' messageKey='message.key'/>). Refer to API Error Code Reference.