DescribeFields - Revision history

Stuarteve: /* Arguments */

2014-06-25T13:18:24Z

‎Arguments

Stuarteve: /* Example */

2014-06-25T13:06:04Z

‎Example

Stuarteve at 14:48, 3 December 2013

2013-12-03T14:48:58Z

Stuarteve at 18:05, 20 November 2013

2013-11-20T18:05:12Z

Stuarteve: Created page with "This method is used to supply a list of available fields within the ARK instance. It will return a JSON array of all the different fields within ARK and their relative ids and sh..."

2013-11-20T17:44:01Z

Created page with "This method is used to supply a list of available fields within the ARK instance. It will return a JSON array of all the different fields within ARK and their relative ids and sh..."

New page

@@ Line 2: / Line 2: @@
 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.
 ===Path===
@@ Line 215: / Line 217: @@
+                         )
+                 )

← Older revision		Revision as of 18:05, 20 November 2013
Line 1:		Line 1:
	This method is used to supply a list of available fields within the ARK instance. It will return a JSON array of all the different fields within ARK and their relative ids and shortnames, and other information.		This method is used to supply a list of available fields within the ARK instance. It will return a JSON array of all the different fields within ARK and their relative ids and shortnames, and other information.
		+
		+	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.

	===Path===		===Path===

@@ Line 11: / Line 11: @@
 ===Arguments===
-*'''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.
+*'''item_key''' - this is in the form 'cxt_cd and refers to the module from which the subform fields are requested. If this is set to 'all' information about all available subform fields are returned.
 If anonymous logins are not enabled a username and password will need to be supplied:

@@ Line 25: / Line 25: @@
 ===Example===
-http://your.ark.instance/api.php?req=describeFields&item_key=hut_cd&handle=johndoe&passwd=johndoepassword
+http://your.ark.instance/api.php?req=describeFields&itemkey=hut_cd&handle=johndoe&passwd=johndoepassword
 Example return (returned JSONified - displayed as an array here for ease of viewing):