ver. 1958 (4e4db56)
Introduction
Sign up
Examples
Changelog
services/apiref
issue
method
method_index
services/apisrv
installation
installations
stats
services/attrs
attribute
attribute_index
attributes
services/caches
edit
geocache
geocaches
mark
save_personal_notes
services/caches/formatters
garmin
ggz
gpx
services/caches/map
tile
services/caches/search
all
bbox
by_urls
nearest
save
services/caches/shortcuts
search_and_retrieve
services/logs
capabilities
delete
edit
entries
entry
logs
submit
userlogs
services/logs/images
add
delete
edit
services/oauth
access_token
authorize
request_token
services/replicate
changelog
fulldump
info
services/users
by_internal_id
by_internal_ids
by_username
by_usernames
user
users

Get information on available logging features
:: services/logs/capabilities method

Minimum Authentication: Level 3 (see Authentication Levels)
https://www.opencaching.us/okapi/services/logs/capabilities

This method tells which features are available when your user will submit or edit a log entry.

Using this method is always optional. You never need to know about differences between OKAPI installations or logging preconditions. If a logging feature is not avaible, OKAPI will accept the request and return a user-friendly explanation. But you may use this method to improve usability of your app, e.g. by disabling nonfunctional options.
cache_code optional

The code of the geocache to be logged. Available features for services/logs/submit will be returned. Either this or the log_uuid argument must be supplied.
log_uuid optional

The UUID of the log entry to be edited. Available features for services/logs/edit will be returned. Either this or the cache_code argument must be supplied.
logtype optional

The type of log entry the user wants to submit; one of the identifiers returned as submittable_logtypes by an earlier call to this method. If given, all the can_ fields will reflect the capabilities for this type of log. See the services/logs/entry method for more information on log types.
format optional Standard common formatting argument.
callback optional Standard common formatting argument.
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization.

Returned value:

A dictionary of the following structure:

  • submittable_logtypes - a list of the log types your user can currently submit for the geocache (or which can replace the type of the log to be edited). Available types depend on many conditions, like the cache type and state.

  • can_recommend - string, tells if the user can add a recommendation for the geocache. One of the following:

    • true - the user can add a recommendation for the geocache,
    • need_more_founds - the user needs to find more caches to add a recommendation for the geocache,
    • false - the user cannot recommend the cache for some other reason, e.g. the user owns or already recommended the cache. A submitted recommendation will be ignored.

    Please note that this field NOT about confirming an existing recommendation by services/logs/edit, which is always possible.

  • rcmd_founds_needed - the number of additional caches the user needs to find (or events to attend) to recommend this cache; null if can_recommend is false.

  • can_rate - boolean, true if the user can rate the geocache; false if a submitted rating will be ignored. Ratings may be disabled for some cache types or for caches that the user already rated or owns. Some OC installations do not provide ratings at all.

  • can_set_needs_maintenance - boolean, true if the user can set or confirm a "needs maintenance" status of the cache by submitting needs_maintenance2=true; false if this argument will be ignored. Logging "needs maintenance" may not be available for all cache types.

  • can_reset_needs_maintenance - boolean, true if the user can reset a "needs maintenance" status of the cache (or confirm that ist still is in good shape) by submitting needs_maintenance2=false; false if this argument will be ignored. This feature is not available yet at some OC installations.

The can_rate and can_..._maintenance fields currently are always false if a log UUID is supplied. OKAPI so far does not implement editing those log properties.