ver. 1926 (dbed1d0) 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 |
Download OKAPI database snapshot
|
|
||||
https://www.opencaching.de/okapi/services/replicate/fulldump | ||||
Download the latest snapshot of OKAPI database. You should call this method only once. For some applications it might be desireable to have a quick access to the entire Opencaching database (instead of querying for specific portions of it). You may use OKAPI's replicate module to achive this state. The changelog method is the primary replication service which you will use. However, to correctly set up your first database copy, you will need to use the fulldump method. A couple of things for you to remember:
Additional notes on data attribution: Cache descriptions will be generated using the attribution_append=static parameter (see the geocache method). This is because the full attributions are not always suitable for replication, since they may contain dynamically changing dates on some installations (why?). To make sure that static attributions are enough, consult the local Data Licence (the Sign Up page). Additional notes on OC team annotations: Cache descriptions will be generated using the oc_team_annotation=description parameter (see the geocache method). This ensures that the team annotations are always displayed alongside the description. If you decide to display them separately (which is recommended!), you may hide the ocTeamCommentSection classed <div> in the description text. |
||||
Plus required consumer_key argument, assigned for your application. | ||||
Returned value: Compressed archive with JSON-encoded files. File named index.json will contain a dictionary of the following structure:
Note: We use TGZ or TBZ2 format to encode this archive:
There are many tools available for handling these archives. In Linux, try "tar -xf filename". |