Difference between revisions of "DescribeARK"

Latest revision as of 15:22, 9 April 2014

This method is used to provide some simple metadata about the ARK instance

Path

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

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=describeARK&handle=johndoe&passwd=johndoepassword

Example return (returned JSONified - displayed as an array here for ease of viewing):

Array
(
    [ark_name] => leskernick
    [ark_name_readable] => The Leskernick ARK
    [version] => 1.2.d
)