ver. 1684 (8b1f529)
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

Save a search result set
:: services/caches/search/save method

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

This works similar to the search/all method, but the returned set of geocaches is temporarilly stored, instead of being directly returned to you.

You may want to use this method when you don't want your search results modified while the user is browsing through them, page by page. To view a portion of a saved search, use the search/all method with proper set_and, offset and status (!) parameters.

min_store optional

Default value: 300

The amount of time (in seconds) after which you allow OKAPI to delete the set (OKAPI may remove it after this time, but doesn't have to). The maximum allowed value is 64800 (18 hours).
ref_max_age optional

Default value: 300

If OKAPI finds an existing result set which was created for your search query, it may return the ID of this existing set (and possibly extend its lifetime so it fits your min_store). What is the maximum age of an existing result set which you are willing to accept?

This should be an integer (in seconds) or a special nolimit value. It must be greater or equal to 300 (5 minutes).

type optional Same as in the services/caches/search/all method.
status optional Same as in the services/caches/search/all method.
owner_uuid optional Same as in the services/caches/search/all method.
name optional Same as in the services/caches/search/all method.
terrain optional Same as in the services/caches/search/all method.
difficulty optional Same as in the services/caches/search/all method.
size optional Same as in the services/caches/search/all method.
size2 optional Same as in the services/caches/search/all method.
rating optional Same as in the services/caches/search/all method.
min_rcmds optional Same as in the services/caches/search/all method.
min_founds optional Same as in the services/caches/search/all method.
max_founds optional Same as in the services/caches/search/all method.
modified_since optional Same as in the services/caches/search/all method.
found_status optional Same as in the services/caches/search/all method.
found_by optional Same as in the services/caches/search/all method.
not_found_by optional Same as in the services/caches/search/all method.
watched_only optional Same as in the services/caches/search/all method.
exclude_ignored optional Same as in the services/caches/search/all method.
ignored_status optional Same as in the services/caches/search/all method.
exclude_my_own optional Same as in the services/caches/search/all method.
with_trackables_only optional Same as in the services/caches/search/all method.
ftf_hunter optional Same as in the services/caches/search/all method.
powertrail_only optional Same as in the services/caches/search/all method.
powertrail_ids optional Same as in the services/caches/search/all method.
set_and optional Same as in the services/caches/search/all method.
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 following structure:

  • set_id - string, the identifier of your saved set, for future reference.