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

Retrieve GGZ file for newer Garmin devices
:: services/caches/formatters/ggz method

Minimum Authentication: Level 1 (see Authentication Levels)
https://opencache.uk/okapi/services/caches/formatters/ggz

Important note: This is a BETA method. It's interface may change in a backward-incompatible manner, or it may even be removed.

Generate a Garmin GGZ file - an alternative to GPX files, compatible with newer Geocaching-enabled Garmin GPS devices. Internally, GGZ file is a ZIP file - it includes the GPX file, plus an index file which allows the device to access specific geocaches much faster.

Currently, this method takes the same parameters as the services/caches/formatters/gpx method. Only the output format is different.
cache_codes required Inherited from services/caches/formatters/gpx method.
langpref optional Inherited from services/caches/formatters/gpx method.
ns_ground optional Inherited from services/caches/formatters/gpx method.
ns_oc optional Inherited from services/caches/formatters/gpx method.
ns_gsak optional Inherited from services/caches/formatters/gpx method.
ns_ox optional Inherited from services/caches/formatters/gpx method.
images optional Inherited from services/caches/formatters/gpx method.
attrs optional Inherited from services/caches/formatters/gpx method.
protection_areas optional Inherited from services/caches/formatters/gpx method.
trackables optional Inherited from services/caches/formatters/gpx method.
recommendations optional Inherited from services/caches/formatters/gpx method.
my_notes optional Inherited from services/caches/formatters/gpx method.
latest_logs optional Inherited from services/caches/formatters/gpx method.
lpc optional Inherited from services/caches/formatters/gpx method.
alt_wpts optional Inherited from services/caches/formatters/gpx method.
mark_found optional Inherited from services/caches/formatters/gpx method.
user_uuid optional Inherited from services/caches/formatters/gpx method.
location_source optional Inherited from services/caches/formatters/gpx method.
location_change_prefix optional Inherited from services/caches/formatters/gpx method.
Plus required consumer_key argument, assigned for your application.

Returned value:

A GGZ file. You should copy the file to Garmin's internal memory storage.