rev. 1076

Retrieve information on a single log entry
:: services/logs/entry method

Minimum Authentication: Level 1 (see Authentication Levels)

Retrieve information on a single log entry.

log_uuid required UUID of the log entry
fields optional

Default value: date|user|type|comment

Pipe-separated list of field names which you are interested with. Selected fields will be included in the response. See below fot the list of available fields.

format optional Standard common formatting argument.
callback optional Standard common formatting argument.
Plus required consumer_key argument, assigned for your application.

Returned value:

A dictionary of fields you have selected. Currently available fields:

  • uuid - unique ID of the log entry,
  • cache_code - code of the cache which the log entry refers to,
  • date - date and time (ISO 8601) when the log entry was submitted.

    Please note that log entries often contain dates only (with the times truncated to midnight, as in the local timezone). In such cases, you may want to avoid displaying the time. You may assume that if the date value contains the "00:00:00" string, then it is date-only.

  • user - a dictionary:

    • uuid - ID of the user (author of the log entry),
    • username - name of the user (who submitted the log entry),
    • profile_url - URL of the profile page of the user,
  • type - string; log type. One of the values documented below.

    Primary types, commonly used by all Opencaching installations:

    • "Found it" - a user found the cache (Non-Event caches).
    • "Didn't find it" - a user searched for, but couldn't find the cache (Non-Event caches).
    • "Comment".
    • "Will attend" - a user is planning to attend the event (for Event caches only).
    • "Attended" - a user has attended the event (for Event caches only).

    Types which indicate a change of state of the geocache or confirm the current state (used only by some Opencaching installations):

    • "Temporarily unavailable" - probably the cache cannot be found, but it may be repaired (then, "Ready to search" will be submitted).
    • "Ready to search" - the cache can be found again.
    • "Archived" - the cache cannot be found and probably won't be repaired.
    • "Locked" - the cache has been archived and can no longer be logged.

    Other types (used only by some Opencaching installations):

    • "Needs maintenance" - a user states that the cache is in need of maintenance.
    • "Maintenance performed" - the cache owner states that he had performed the maintenance.
    • "Moved" - the cache has been moved to a different location.
    • "OC Team comment" - a comment made by the official OC Team member.
    • (to be continued) - this list MAY expand in time! Your application should accept unknown log types (you may treat them as "Comment"s).
  • oc_team_entry - true if the log entry has been made by an official OC team member and marked as administrative log; false if it has not been marked.

    Note: false does NOT mean that it is no administrative log, because this flag can be missing for (mostly old) admin logs.

  • was_recommended - true, if the author included his recommendation in this log entry,

  • comment - HTML string, text entered with the log entry,
  • images - list of dictionaries, each dictionary represents one image saved along with the log; each dictionary has the following structure:

    • uuid - UUID of the image,
    • url - URL of the image,
    • thumb_url - URL of a small (thumb) version of the image,
    • caption - plain-text string, caption of the image,
    • is_spoiler - boolean, if true then the image is a spoiler image and should not be displayed to the user unless the user explicitly asks for it.
  • internal_id - undocumented, you should not use this unless you really know you need to. Internal IDs are not unique across various OKAPI installations. Try to use UUIDs instead.

Note, that some fields can change in time (users can edit/delete their log entries).

If given log entry does not exist, the method will respond with an HTTP 400 error.