DescribeFilters

From ARK
Revision as of 15:49, 15 November 2013 by Stuarteve (talk | contribs) (Arguments)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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

Path

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

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

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

Array
(
    [1] => test
    [2] => western
    [3] => Shaman FreeText
)