ver. 1382 (3aeabce)

Edit an existing log entry image
:: services/logs/images/edit method

Minimum Authentication: Level 3 (see Authentication Levels)

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).

is_spoiler optional

One of the following:

  • true - marks the image as spoiler, which means that it contains hints for finding the geocache.
  • false - marks the image as non-spoiler.
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 only OCDE-based Opencaching installations allow for the order of log images to be changed. OCPL-based installations will ignore this parameter (you can check the position field in the response to verify if the order has actually been changed or not).

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:

  • success - true, if the image was edited successfully,
  • message - plain-text string, a message for the user, which acknowledges success or describes an error (usually you want to display this only when success is false),
  • position:

    • If you have supplied the position parameter, then this field will contain a 0-based position of the image on the log entry's list of images - the position which was actually saved (it may differ from the position you have requested).
    • If you have not supplied the position parameter, it will contain null.
    • In case of an error, it will also contain null.