ver. 2022 (529bbbd)
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

Set or remove personal coordinates of a geocache
:: services/caches/save_user_coords method

Minimum Authentication: Level 3 (see Authentication Levels)
https://www.opencaching.nl/okapi/services/caches/save_user_coords

This method allows your users to set or remove their own (corrected) coordinates of a geocache, e.g. the solved final location of a mystery cache. Each user has at most one such location per geocache.

Current personal coordinates for the geocache can be retrieved using the user_coords field (or the user-coords entry of the alt_wpts field) in the services/caches/geocache method.

cache_code required

Code of the geocache.

Note: On OCPL-based sites, user coordinates are only supported for caches of type Multi, Quiz, and Other. Supplying a cache of any other type will result in an HTTP 400 error.

new_value required

The new coordinates, as a string in the format "lat|lon". An empty string removes the user's coordinates. "0|0" is rejected.

Use positive numbers for latitudes in the northern hemisphere and longitudes in the eastern hemisphere (and negative for southern and western hemispheres accordingly). These are full degrees with a dot as a decimal point (ex. "48.7|15.89").

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:

  • saved_value - the user's coordinates as stored now, in the "lat|lon" format, or null if they have been removed.