33 lines
1.3 KiB
XML
33 lines
1.3 KiB
XML
<xml>
|
|
<brief>Mark cache as watched or ignored</brief>
|
|
<issue-id>166</issue-id>
|
|
<desc>
|
|
<p>This method allows your users to mark the geocache as <b>watched</b> or
|
|
<b>ignored</b>.
|
|
Read the docs on separate parameters for details.</p>
|
|
</desc>
|
|
<req name='cache_code'>
|
|
<p>Code of the geocache.</p>
|
|
</req>
|
|
<opt name='watched' default='unchanged'>
|
|
<p>Mark (or unmark) the cache as watched. This should be <b>true</b>,
|
|
<b>false</b> or <b>unchanged</b>. You may access the current state of this
|
|
flag with the <b>is_watched</b> field of the geocache method.</p>
|
|
</opt>
|
|
<opt name='ignored' default='unchanged'>
|
|
<p>Mark (or unmark) the cache as ignored. This should be <b>true</b>,
|
|
<b>false</b> or <b>unchanged</b>. You may access the current state of this
|
|
flag with the <b>is_ignored</b> field of the geocache method.</p>
|
|
</opt>
|
|
<common-format-params/>
|
|
<returns>
|
|
<p>A dictionary of the following structure:</p>
|
|
<ul>
|
|
<li><b>success</b> - true, if all went well.</li>
|
|
</ul>
|
|
<p>Please note, that currently this will <b>always</b> be true! Nothing can go
|
|
wrong as long as you pass your parameters in a right way (and if you don't,
|
|
you will get an HTTP 400 response). If you have received an HTTP 200 response,
|
|
then you may assume that all went well.</p>
|
|
</returns>
|
|
</xml> |