Difference between revisions of "TranscludeSubform"

From ARK
Jump to: navigation, search
(Created page with "This method is used to return the an HTML rendered representation of a subform. Available subforms in the ARK instance can be queried using describeSubforms ===Path=== http...")
 
(Arguments)
 
(One intermediate revision by the same user not shown)
Line 7: Line 7:
 
===Arguments===
 
===Arguments===
  
*''sf_conf'' - the name of the subform to be transcluded
+
*'''sf_conf''' - the name of the subform to be transcluded
  
 
If anonymous logins are not enabled a username and password will need to be supplied:
 
If anonymous logins are not enabled a username and password will need to be supplied:

Latest revision as of 14:37, 3 December 2013

This method is used to return the an HTML rendered representation of a subform. Available subforms in the ARK instance can be queried using describeSubforms

Path

http://your.ark.instance/api.php?req=transcludeSubform

Arguments

  • sf_conf - the name of the subform to be transcluded

If anonymous logins are not enabled a username and password will need to be supplied:

  • handle - username
  • passwd - password

Example

Example - transcluding a text subform

http://your.ark.instance/api.php?req=transcludeSubform&item_key=hut_cd&hut_cd=LK12_1&sf_conf=settlements&handle=johndoe&passwd=johndoepassword

Example return (returned as HTML):

TranscludedSubform.png