Introduction
Sign up
Examples
Changelog
|
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 |
Retrieve information on multiple geocaches
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||
| https://www.opencaching.us/okapi/services/caches/geocaches | ||||
|
This method works like the services/caches/geocache method, but works with multiple geocaches (instead of only one). |
||||
| cache_codes | required |
Pipe-separated list of geocache codes. These represent the geocaches you are interested in. No more than 500 codes are allowed. Unlike in the "geocache" method, this CAN be an empty string (it will result in an empty, but valid, response). |
||
| 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 fields like name and description. Please note, that you may also access caches' descriptions in all available languages. If you want to do this, you should use fields names, descriptions (etc.) instead of name and description (etc.). |
||
| fields | optional |
Default value: code|name|location|type|status Same as in the services/caches/geocache method. Pipe-separated list of field names which you are interested with. See services/caches/geocache method for a list available values. |
||
| attribution_append | optional |
Default value: full Same as in the services/caches/geocache method. |
||
| oc_team_annotation | optional |
Default value: description Same as in the services/caches/geocache method. |
||
| owner_fields | optional |
Default value: uuid|username|profile_url Same as in the services/caches/geocache method. |
||
| lpc | optional |
Default value: 10 Same as in the services/caches/geocache method. |
||
| log_fields | optional |
Default value: uuid|date|user|type|comment Same as in the services/caches/geocache method. |
||
| log_user_fields | optional |
Default value: uuid|username|profile_url Same as in the services/caches/geocache method. |
||
| user_logs_only | optional |
Default value: false Same as in the services/caches/geocache method. |
||
| my_location | optional | Same as in the services/caches/geocache method. | ||
| user_uuid | optional | Same as in the services/caches/geocache 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. Cache codes you provide will be mapped to dictionary keys, and each value will be a dictionary of fields you have selected. For example, for geocaches?cache_codes=OP3D96|OC124&fields=type query, the result might look something link this: {"OP3D96": {"type": "Traditional"}, "OC124": null}
Value of null means that no geocache by this code has been found. (This behavior is different than in the services/caches/geocache method, which responds with a HTTP 400 error in such case.) | ||||