https://ark.lparchaeology.com/wiki/index.php?action=history&feed=atom&title=DescribeSubforms
DescribeSubforms - Revision history
2026-04-30T15:53:54Z
Revision history for this page on the wiki
MediaWiki 1.27.1
https://ark.lparchaeology.com/wiki/index.php?title=DescribeSubforms&diff=3158&oldid=prev
Stuarteve at 18:05, 20 November 2013
2013-11-20T18:05:37Z
<p></p>
<table class="diff diff-contentalign-left" data-mw="interface">
<col class='diff-marker' />
<col class='diff-content' />
<col class='diff-marker' />
<col class='diff-content' />
<tr style='vertical-align: top;' lang='en'>
<td colspan='2' style="background-color: white; color:black; text-align: center;">← Older revision</td>
<td colspan='2' style="background-color: white; color:black; text-align: center;">Revision as of 18:05, 20 November 2013</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l1" >Line 1:</td>
<td colspan="2" class="diff-lineno">Line 1:</td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>This method is used to supply a list of available subforms within the ARK instance. It will return a JSON array of all the different subforms within ARK and their relative ids and shortnames. This can be used in conjunction with [[transcludeSubforms]]() to retrieve rendered HTML of parts of the ARK instance.</div></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>This method is used to supply a list of available subforms within the ARK instance. It will return a JSON array of all the different subforms within ARK and their relative ids and shortnames. This can be used in conjunction with [[transcludeSubforms]]() to retrieve rendered HTML of parts of the ARK instance.</div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">Please note this method respects any security conditions set in the subform configuration - therefore if fields are, for instance, being restricted on userids or security groups they will not be made available for return by the API.</ins></div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>===Path===</div></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>===Path===</div></td></tr>
</table>
Stuarteve
https://ark.lparchaeology.com/wiki/index.php?title=DescribeSubforms&diff=3152&oldid=prev
Stuarteve at 16:17, 15 November 2013
2013-11-15T16:17:04Z
<p></p>
<table class="diff diff-contentalign-left" data-mw="interface">
<col class='diff-marker' />
<col class='diff-content' />
<col class='diff-marker' />
<col class='diff-content' />
<tr style='vertical-align: top;' lang='en'>
<td colspan='2' style="background-color: white; color:black; text-align: center;">← Older revision</td>
<td colspan='2' style="background-color: white; color:black; text-align: center;">Revision as of 16:17, 15 November 2013</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l1" >Line 1:</td>
<td colspan="2" class="diff-lineno">Line 1:</td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>This method is used to supply a list of available subforms within the ARK instance. It will return a JSON array of all the different subforms within ARK and their relative ids and shortnames.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>This method is used to supply a list of available subforms within the ARK instance. It will return a JSON array of all the different subforms within ARK and their relative ids and shortnames<ins class="diffchange diffchange-inline">. This can be used in conjunction with [[transcludeSubforms]]() to retrieve rendered HTML of parts of the ARK instance</ins>.</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>===Path===</div></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>===Path===</div></td></tr>
</table>
Stuarteve
https://ark.lparchaeology.com/wiki/index.php?title=DescribeSubforms&diff=3151&oldid=prev
Stuarteve: Created page with "This method is used to supply a list of available subforms within the ARK instance. It will return a JSON array of all the different subforms within ARK and their relative ids an..."
2013-11-15T16:15:58Z
<p>Created page with "This method is used to supply a list of available subforms within the ARK instance. It will return a JSON array of all the different subforms within ARK and their relative ids an..."</p>
<p><b>New page</b></p><div>This method is used to supply a list of available subforms within the ARK instance. It will return a JSON array of all the different subforms within ARK and their relative ids and shortnames.<br />
<br />
===Path===<br />
<br />
http://your.ark.instance/api.php?req=describeSubforms<br />
<br />
===Arguments===<br />
<br />
*'''item_key''' - this is in the form 'cxt_cd and refers to the module from which the subforms are requested. If this is set to 'all' information about all available subforms are returned.<br />
<br />
If anonymous logins are not enabled a username and password will need to be supplied:<br />
<br />
*'''handle''' - username<br />
<br />
*'''passwd''' - password<br />
<br />
The method returns a JSON array unless otherwise specified:<br />
<br />
*'''format''' - 'json' by default, but sending 'html' prints a human-readable array to screen<br />
<br />
===Example===<br />
<br />
http://your.ark.instance/api.php?req=describeSubforms&item_key=hut_cd&handle=johndoe&passwd=johndoepassword<br />
<br />
Example return (returned JSONified - displayed as an array here for ease of viewing):<br />
<br />
<pre><br />
Array<br />
(<br />
[hut] => Array<br />
(<br />
[hut_desc] => Array<br />
(<br />
[view_state] => max<br />
[edit_state] => view<br />
[sf_title] => desc<br />
[sf_html_id] => hut_desc<br />
[script] => php/subforms/sf_txt.php<br />
[sf_nav_type] => full<br />
[op_label] => space<br />
[op_input] => save<br />
[fields] => Array<br />
(<br />
[0] => Array<br />
(<br />
[field_id] => conf_field_description<br />
[dataclass] => txt<br />
[classtype] => notes<br />
[aliasinfo] => <br />
[editable] => 1<br />
[hidden] => <br />
[add_validation] => Array<br />
(<br />
[0] => Array<br />
(<br />
[rq_func] => reqManual<br />
[vd_func] => chkSet<br />
[var_name] => cre_on<br />
[force_var] => NOW()<br />
)<br />
<br />
[1] => Array<br />
(<br />
[rq_func] => reqManual<br />
[vd_func] => chkSet<br />
[var_name] => log<br />
[force_var] => on<br />
)<br />
<br />
[2] => Array<br />
(<br />
[rq_func] => reqMulti<br />
[vd_func] => chkSet<br />
[var_name] => ste_cd<br />
[lv_name] => ste_cd<br />
[var_locn] => session<br />
)<br />
<br />
[3] => Array<br />
(<br />
[rq_func] => reqMulti<br />
[vd_func] => chkSet<br />
[var_name] => cre_by<br />
[lv_name] => user_id<br />
[var_locn] => live<br />
)<br />
<br />
[4] => Array<br />
(<br />
[rq_func] => reqClassType<br />
[vd_func] => chkSet<br />
[var_name] => txttype<br />
[lv_name] => classtype<br />
[var_locn] => field<br />
)<br />
<br />
[5] => Array<br />
(<br />
[rq_func] => reqMulti<br />
[vd_func] => chkSkipBlank<br />
[var_name] => txt<br />
[lv_name] => dyn_field<br />
[var_locn] => request<br />
)<br />
<br />
[6] => Array<br />
(<br />
[rq_func] => reqMulti<br />
[vd_func] => chkSet<br />
[var_name] => itemkey<br />
[lv_name] => item_key<br />
[var_locn] => live<br />
)<br />
<br />
[7] => Array<br />
(<br />
[rq_func] => reqItemVal<br />
[vd_func] => chkSet<br />
[var_name] => itemval<br />
[lv_name] => itemval<br />
[var_locn] => request<br />
[req_keytype] => auto<br />
[ret_keytype] => cd<br />
)<br />
<br />
[8] => Array<br />
(<br />
[rq_func] => reqMulti<br />
[vd_func] => chkSet<br />
[var_name] => lang<br />
[lv_name] => lang<br />
[var_locn] => live<br />
)<br />
<br />
)<br />
<br />
[edt_validation] => Array<br />
(<br />
[0] => Array<br />
(<br />
[rq_func] => reqManual<br />
[vd_func] => chkSet<br />
[var_name] => cre_on<br />
[force_var] => NOW()<br />
)<br />
<br />
[1] => Array<br />
(<br />
[rq_func] => reqManual<br />
[vd_func] => chkSet<br />
[var_name] => log<br />
[force_var] => on<br />
)<br />
<br />
[2] => Array<br />
(<br />
[rq_func] => reqMulti<br />
[vd_func] => chkSet<br />
[var_name] => ste_cd<br />
[lv_name] => ste_cd<br />
[var_locn] => session<br />
)<br />
<br />
[3] => Array<br />
(<br />
[rq_func] => reqMulti<br />
[vd_func] => chkSet<br />
[var_name] => cre_by<br />
[lv_name] => user_id<br />
[var_locn] => live<br />
)<br />
<br />
[4] => Array<br />
(<br />
[rq_func] => reqClassType<br />
[vd_func] => chkSet<br />
[var_name] => txttype<br />
[lv_name] => classtype<br />
[var_locn] => field<br />
)<br />
<br />
[5] => Array<br />
(<br />
[rq_func] => reqMulti<br />
[vd_func] => chkSkipBlank<br />
[var_name] => txt<br />
[lv_name] => dyn_field<br />
[var_locn] => request<br />
)<br />
<br />
[6] => Array<br />
(<br />
[rq_func] => reqMulti<br />
[vd_func] => chkSet<br />
[var_name] => itemkey<br />
[lv_name] => item_key<br />
[var_locn] => live<br />
)<br />
<br />
[7] => Array<br />
(<br />
[rq_func] => reqItemVal<br />
[vd_func] => chkSet<br />
[var_name] => itemval<br />
[lv_name] => itemval<br />
[var_locn] => request<br />
[req_keytype] => auto<br />
[ret_keytype] => cd<br />
)<br />
<br />
[8] => Array<br />
(<br />
[rq_func] => reqFragId<br />
[vd_func] => chkSet<br />
[var_name] => frag_id<br />
[lv_name] => id<br />
[var_locn] => request<br />
)<br />
<br />
[9] => Array<br />
(<br />
[rq_func] => reqMulti<br />
[vd_func] => chkSet<br />
[var_name] => lang<br />
[lv_name] => lang<br />
[var_locn] => live<br />
)<br />
<br />
)<br />
<br />
)<br />
<br />
)<br />
<br />
[frame] => <br />
)<br />
)<br />
<br />
)<br />
</pre></div>
Stuarteve