ver. 1865 (f82869d)
services/apiref
services/apisrv
services/attrs
services/caches
services/caches/formatters
services/caches/map
services/caches/search
services/caches/shortcuts
services/logs
services/logs/images
services/oauth
services/replicate
services/users

Get information on available geocache properties
:: services/caches/capabilities method

Minimum Authentication: Level 1 (see Authentication Levels)
https://opencaching.pl/okapi/services/caches/capabilities

Returns information on available geocache properties at this OKAPI installation.

You may need this method when editing geocache listings and when searching for caches by type. In all other cases, you don't need to know about differences between OKAPI installations. But still this method may help to improve usability of your app, e.g. by hiding unnecessary search options.

fields optional

Default value: types|sizes|statuses|has_ratings

Pipe-separated list of field names which you are interested in. Selected fields will be included in the response. See below for the list of available fields.

(Why a fields option? Because fields like countries and languages may be added, that return lots of data or are expensive to calculate.)

format optional Standard common formatting argument.
callback optional Standard common formatting argument.
Plus required consumer_key argument, assigned for your application.

Returned value:

A dictionary of the fields you have selected. Currently available fields:

  • types - list of the cache types which are currently available at this installation. See the services/caches/geocache method for more information on cache types.

  • sizes - list of the cache sizes which are currently available at this installation.

  • statuses - list of the cache statuses which are currently available at this installation. See the services/caches/geocache method for more information on cache types.

  • has_ratings - boolean, true if this installation can store geocache quality ratings. Use the services/logs/capabilities method to find out if a given geocache can be rated.

  • password_max_length - the maximum length of a password that will be accepted by services/caches/edit.