rev. 334
Introduction
Sign up
Examples
services/apiref
issue
method
method_index
services/apisrv
installation
installations
stats
services/caches
geocache
geocaches
services/caches/formatters
garmin
gpx
services/caches/search
all
bbox
nearest
services/caches/shortcuts
search_and_retrieve
services/logs
entries
entry
logs
submit
userlogs
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 ZIP file for Garmin devices
:: services/caches/formatters/garmin method

Minimum Authentication: Level 1 (see Authentication Levels)
http://www.opencaching.us/okapi/services/caches/formatters/garmin

Produce a ZIP file with content compatible with Geocaching-enabled Garmin GPS devices. The general idea is, you should extract the contents of the ZIP file directly into the root directory of your Garmin's internal memory storage (currently it doesn't work if you extract the data to the external MicroSD card). The device will then be filled with all the data we are currently able to fill it with.

Currently, the ZIP file will contain GPX file and all JPEG images associated with the chosen geocaches. Options for the GPX file are fixed, use the services/caches/formatters/gpx method if you want a custom-tailored GPX file.

Important note: The contents of the returned ZIP archive may change in the future. You should not parse the contents, nor assume that they have any specific structure.

Important note: We might be increasing required authentication level for this method to level 2 or 3. You should be prepared for that. Use the highest authentication level you've got. Also, if you want the GPX file to include personal data (like user's notes), you have to use Level 3 Authentication anyway.

Note: All non-JPEG images will be skipped. Currently OKAPI does not convert other types of images to JPEG.
cache_codes required

Pipe-separated list of cache codes which you are interested in. No more than 50 codes are allowed. (This limit is smaller than usual, because we're afraid about the sizes of ZIP files produced.) This CAN be an empty string (it will still result in a valid ZIP file).
langpref optional

Default value: en

Pipe-separated list of ISO 639-1 language codes. This indicates the order of preference in which language will be chosen for GPX entities.
images optional

Default value: all

One of the following values:

  • none - no images will be included in the result,
  • all - all images will be included in the result,
  • spoilers - only spoiler images will be included in the result,
  • nonspoilers - only non-spoiler images will be included in the result.
Plus required consumer_key argument, assigned for your application.

Returned value:

ZIP file. You should extract it's contents directly into the root directory of your Garmin's internal memory storage.