ver. 1958 (4e4db56)
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

Mark cache as watched or ignored
:: services/caches/mark method

Minimum Authentication: Level 3 (see Authentication Levels)
https://opencache.uk/okapi/services/caches/mark

This method allows your users to mark the geocache as watched or ignored. Read the docs on separate parameters for details.

cache_code required

Code of the geocache.

watched optional

Default value: unchanged

Mark (or unmark) the cache as watched. This should be true, false or unchanged. You may access the current state of this flag with the is_watched field of the geocache method.

ignored optional

Default value: unchanged

Mark (or unmark) the cache as ignored. This should be true, false or unchanged. You may access the current state of this flag with the is_ignored field of the geocache method.

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:

  • success - true, if all went well.

Please note, that currently this will always be true! Nothing can go wrong as long as you pass your parameters in a right way (and if you don't, you will get an HTTP 400 response). If you have received an HTTP 200 response, then you may assume that all went well.