DescribeItems - Revision history

Stuarteve: /* Arguments */

2013-11-15T15:50:19Z

‎Arguments

Stuarteve at 16:33, 14 November 2013

2013-11-14T16:33:08Z

Stuarteve: /* Example */

2013-11-12T10:49:58Z

‎Example

Stuarteve: /* Example */

2013-11-12T10:43:47Z

‎Example

Stuarteve: /* Example */

2013-11-12T10:42:16Z

‎Example

Stuarteve: /* Example */

2013-11-12T10:41:09Z

‎Example

Stuarteve: /* Example */

2013-11-12T10:39:04Z

‎Example

Stuarteve: /* Arguments */

2013-11-12T10:38:15Z

‎Arguments

Stuarteve: /* Arguments */

2013-11-12T10:35:40Z

‎Arguments

Stuarteve: /* Arguments */

2013-11-12T10:35:01Z

‎Arguments

@@ Line 7: / Line 7: @@
 ===Arguments===
-This method has no other mandatory arguments, although if anonymous logins are not enabled a username and password will need to be supplied:
+This method has no mandatory arguments, although if anonymous logins are not enabled a username and password will need to be supplied:
 *'''handle''' - username
 *'''passwd''' - password
 ===Example===

@@ Line 3: / Line 3: @@
 ===Path===
-http://your.ark.instance/api.php?request=describeItems
+http://your.ark.instance/api.php?req=describeItems
 ===Arguments===
@@ Line 15: / Line 15: @@
 ===Example===
-http://your.ark.instance/api.php?request=describeItems&handle=johndoe&passwd=johndoepassword
+http://your.ark.instance/api.php?req=describeItems&handle=johndoe&passwd=johndoepassword
 Example return (returned JSONified - displayed as an array here for ease of viewing):

@@ Line 17: / Line 17: @@
 http://your.ark.instance/api.php?request=describeItems&handle=johndoe&passwd=johndoepassword
-Example return:
+Example return (returned JSONified - displayed as an array here for ease of viewing):
 <pre>
 Array
+(
      [0] => Array

@@ Line 22: / Line 22: @@
 <pre>
-[{"0":"1","id":"1","1":"hut_cd","itemkey":"hut_cd","2":"mod_hut","name":"mod_hut",
+<pre>Array
-"3":"hut","shortform":"hut","4":"The hut module","description":"The hut module","5":"2","cre_by":"2","6":"2006-06-03 00:00:00","cre_on":"2006-06-03 00:00:00","aliases":[{"0":"130","id":"130","1":"Hut","alias":"Hut","2":"en",
-"language":"en"}]},{"0":"3","id":"3","1":"adm_cd","itemkey":"adm_cd","2":"mod_adm","name":"mod_adm",
+    [0] => Array
-"3":"adm","shortform":"adm","4":"The adm module","description":"The adm module","5":"2","cre_by":"2","6":"2006-06-03 00:00:00","cre_on":"2006-06-03 00:00:00","aliases":[{"0":"132","id":"132","1":"Site Photo","alias":"Site Photo","2":"en","language":"en"},{"0":"306","id":"306","1":"Admin","alias":"Admin","2":"en","language":"en"}]},{"0":"8","id":"8","1":"abk_cd","itemkey":"abk_cd","2":"mod_abk","name":"mod_abk",
-"3":"abk","shortform":"abk","4":"The abk module","description":"The abk module","5":"2","cre_by":"2","6":"2006-06-03 00:00:00","cre_on":"2006-06-03 00:00:00","aliases":[{"0":"178","id":"178","1":"Address Book","alias":"Address Book","2":"en","language":"en"}]}]
+            [0] => 1
 </pre>

@@ Line 20: / Line 20: @@
-<source lang=JavaScript>
+<pre>
-[{"0":"1","id":"1","1":"hut_cd","itemkey":"hut_cd","2":"mod_hut","name":"mod_hut","3":"hut","shortform":"hut","4":"The hut module","description":"The hut module","5":"2","cre_by":"2","6":"2006-06-03 00:00:00","cre_on":"2006-06-03 00:00:00","aliases":[{"0":"130","id":"130","1":"Hut","alias":"Hut","2":"en","language":"en"}]},{"0":"3","id":"3","1":"adm_cd","itemkey":"adm_cd","2":"mod_adm","name":"mod_adm","3":"adm","shortform":"adm","4":"The adm module","description":"The adm module","5":"2","cre_by":"2","6":"2006-06-03 00:00:00","cre_on":"2006-06-03 00:00:00","aliases":[{"0":"132","id":"132","1":"Site Photo","alias":"Site Photo","2":"en","language":"en"},{"0":"306","id":"306","1":"Admin","alias":"Admin","2":"en","language":"en"}]},{"0":"8","id":"8","1":"abk_cd","itemkey":"abk_cd","2":"mod_abk","name":"mod_abk","3":"abk","shortform":"abk","4":"The abk module","description":"The abk module","5":"2","cre_by":"2","6":"2006-06-03 00:00:00","cre_on":"2006-06-03 00:00:00","aliases":[{"0":"178","id":"178","1":"Address Book","alias":"Address Book","2":"en","language":"en"}]}]
+[{"0":"1","id":"1","1":"hut_cd","itemkey":"hut_cd","2":"mod_hut","name":"mod_hut",
-</source>
+</pre>

← Older revision		Revision as of 10:39, 12 November 2013
Line 18:		Line 18:

	Example return:		Example return:
		+
		+	<pre>

	[{"0":"1","id":"1","1":"hut_cd","itemkey":"hut_cd","2":"mod_hut","name":"mod_hut","3":"hut","shortform":"hut","4":"The hut module","description":"The hut module","5":"2","cre_by":"2","6":"2006-06-03 00:00:00","cre_on":"2006-06-03 00:00:00","aliases":[{"0":"130","id":"130","1":"Hut","alias":"Hut","2":"en","language":"en"}]},{"0":"3","id":"3","1":"adm_cd","itemkey":"adm_cd","2":"mod_adm","name":"mod_adm","3":"adm","shortform":"adm","4":"The adm module","description":"The adm module","5":"2","cre_by":"2","6":"2006-06-03 00:00:00","cre_on":"2006-06-03 00:00:00","aliases":[{"0":"132","id":"132","1":"Site Photo","alias":"Site Photo","2":"en","language":"en"},{"0":"306","id":"306","1":"Admin","alias":"Admin","2":"en","language":"en"}]},{"0":"8","id":"8","1":"abk_cd","itemkey":"abk_cd","2":"mod_abk","name":"mod_abk","3":"abk","shortform":"abk","4":"The abk module","description":"The abk module","5":"2","cre_by":"2","6":"2006-06-03 00:00:00","cre_on":"2006-06-03 00:00:00","aliases":[{"0":"178","id":"178","1":"Address Book","alias":"Address Book","2":"en","language":"en"}]}]		[{"0":"1","id":"1","1":"hut_cd","itemkey":"hut_cd","2":"mod_hut","name":"mod_hut","3":"hut","shortform":"hut","4":"The hut module","description":"The hut module","5":"2","cre_by":"2","6":"2006-06-03 00:00:00","cre_on":"2006-06-03 00:00:00","aliases":[{"0":"130","id":"130","1":"Hut","alias":"Hut","2":"en","language":"en"}]},{"0":"3","id":"3","1":"adm_cd","itemkey":"adm_cd","2":"mod_adm","name":"mod_adm","3":"adm","shortform":"adm","4":"The adm module","description":"The adm module","5":"2","cre_by":"2","6":"2006-06-03 00:00:00","cre_on":"2006-06-03 00:00:00","aliases":[{"0":"132","id":"132","1":"Site Photo","alias":"Site Photo","2":"en","language":"en"},{"0":"306","id":"306","1":"Admin","alias":"Admin","2":"en","language":"en"}]},{"0":"8","id":"8","1":"abk_cd","itemkey":"abk_cd","2":"mod_abk","name":"mod_abk","3":"abk","shortform":"abk","4":"The abk module","description":"The abk module","5":"2","cre_by":"2","6":"2006-06-03 00:00:00","cre_on":"2006-06-03 00:00:00","aliases":[{"0":"178","id":"178","1":"Address Book","alias":"Address Book","2":"en","language":"en"}]}]
		+
		+	</pre>

@@ Line 9: / Line 9: @@
 This method has no other mandatory arguments, although if anonymous logins are not enabled a username and password will need to be supplied:
-handle - username
+[handle] - username
-passwd - password
+[passwd] - password
 ===Example===