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 image
|
|
||||
https://www.opencaching.de/okapi/services/logs/images/edit | ||||
This method allows you to change properties of an existing log entry image. If you need to change the image itself, then you'll need to delete it and re-add it. At least one of the three parameters caption, is_spoiler and position must be supplied. |
||||
image_uuid | required |
ID of the log entry image to be edited. The user of your Access Token must be the author of the associated log entry. |
||
caption | optional |
Plain-text string, a new caption for the image. Please note that providing an empty value indicates that your user would like to remove the caption, which will often not be allowed (then success will be false). Note: Some OC 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. |
||
is_spoiler | optional |
One of the following:
|
||
position | optional |
If given, it indicates the wanted position of this image on the log entry's list of images (do not supply this parameter if you do not want to change the order). This parameter takes the same 0-based value as described in the add method. Please note that some Opencaching installations don't implement image positioning; they will ignore this parameter. The services/apisrv/installation method tells if image positioning is available. |
||
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:
|