rev. 1076
services/apiref
services/apisrv
services/attrs
services/caches
services/caches/formatters
services/caches/map
services/caches/search
services/caches/shortcuts
services/logs
services/oauth
services/replicate
services/users

Get information on this OKAPI installation
:: services/apisrv/installation method

Minimum Authentication: Level 0 (see Authentication Levels)
http://www.opencaching.us/okapi/services/apisrv/installation
Retrieve some basic information about this OKAPI installation.
format optional Standard common formatting argument.
callback optional Standard common formatting argument.
No additional authentication parameters are required.

Returned value:

A dictionary of the following structure:

  • site_url - URL of the Opencaching site which is running the OKAPI installation (usually this looks like "http://www.opencaching.xx/", where xx is a top level domain of a country).
  • okapi_base_url - URL of the OKAPI installation (usually this is site_url with "okapi/" appended, but you should not assume that); this value is to be used as a prefix when constructing service method URLs,
  • site_name - international name of the Opencaching site,
  • okapi_revision - integer, an SVN revision of the OKAPI project installed on this Opencaching site, or null, when could not determine revision number.