DescribeItems

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?req=describeItems

Arguments

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

The method returns a JSON array unless otherwise specified:

• format - 'json' by default, but sending 'html' prints a human-readable array to screen

Example

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):

Array
(
    [0] => Array
        (
            [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] => Array
                (
                    [0] => Array
                        (
                            [0] => 130
                            [id] => 130
                            [1] => Hut
                            [alias] => Hut
                            [2] => en
                            [language] => en
                        )

                )

        )

    [1] => Array
        (
            [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] => Array
                (
                    [0] => Array
                        (
                            [0] => 132
                            [id] => 132
                            [1] => Site Photo
                            [alias] => Site Photo
                            [2] => en
                            [language] => en
                        )

                    [1] => Array
                        (
                            [0] => 306
                            [id] => 306
                            [1] => Admin
                            [alias] => Admin
                            [2] => en
                            [language] => en
                        )

                )

        )
)