Difference between revisions of "DescribeItems"

From ARK
Jump to: navigation, search
(Created page with "This method is used to supply a list of available items within the ARK instance. It will return a JSON array of all the different modules within ARK and their relative ids and it...")
 
(Arguments)
Line 7: Line 7:
 
===Arguments===
 
===Arguments===
  
If anonymous logins are not enabled a username and password will need to be supplied:
+
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
  

Revision as of 10:35, 12 November 2013

This method is used to supply a list of available items within the ARK instance. It will return a JSON array of all the different modules within ARK and their relative ids and itemkeys.

Path

http://your.ark.instance/api.php?request=describeItems

Arguments

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

passwd - password

Example

http://your.ark.instance/api.php?request=describeItems&handle=johndoe&passwd=johndoepassword

Example return:

[{"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"}]}]