Introduction
Sign up
Examples
Changelog
|
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 |
Edit an existing log entry
|
||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||
| https://www.opencaching.de/okapi/services/logs/edit | ||||
|
This method allows your user to change the content of own log entries. At least one of the optional parameters with submitted log data must be supplied. |
||||
| log_uuid | required |
ID of the log entry to be edited. The user of your Access Token must be the author of the log entry. |
||
| logtype | optional |
New type of the log entry. This may be one of:
For now, only the same five log types can be changed. If the log (before editing) is of another type, e.g. Available, the response will be success=false and an explanatory message. More log types may be editable in the future, so you MUST NOT rely on a success=false response for certain types. If your user did recommend or rate the cache and the log type is changed from "Found it" or "Attended" to something else, the recommendation and rating will be withdrawn. |
||
| password | optional |
Some caches require a password in order to submit a "Found it" or "Attended" log entry. It must be supplied here if the log type is changed to "Found it" or "Attended". In all other cases, password is ignored. You may check if this cache requires a password with req_passwd field of the services/caches/geocache method. |
||
| comment | optional |
New text to store with the log entry; will replace the existing text. The comment_format must be supplied with the comment. Note: Some OCPL-based sites support only BMP (Basic Multilingual Plane) Unicode characters on some database fields. If you submit characters from outside of the BMP plane (known as "supplementary planes", they include characters such as smiley symbols), then keep in mind that your text might be saved garbled. |
||
| comment_format | optional |
Indicates the format of your comment, either html or plaintext. Important note: The subset of allowed HTML elements is left undefined and may change in the future. For future-compatibility, you should use only basic formatting tags. |
||
| when | optional |
Same as in the services/logs/submit method, but without a default value. |
||
| recommend | optional |
Default value: unchanged Confirms or changes the user's recommendation for the cache; one of the following:
|
||
| rating | optional |
Default value: unchanged If the user rated the cache, the option false will withdraw that rating. Otherwise, it will be ignored (which includes installations that do not provide geocache ratings; see the has_ratings field of services/caches/capabilities). |
||
| 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 error messages. |
||
| format | optional | Standard common formatting argument. | ||
| callback | optional | Standard common formatting argument. | ||
| Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization. | ||||
|
Returned value: A dictionary of the following structure:
| ||||