Log types: Difference between revisions

From Opencaching.eu
Jump to navigation Jump to search
VisualWikitext
No edit summary
(Added OKAPI properties: API string & submittable flag)
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Category:Assigned numbers]]
[[index.php?title=Category:Assigned numbers]]
[[Category:Logs]]
[[index.php?title=Category:Cache]]
[[Category:Opencaching-DE]]
[[index.php?title=Category:Log]]
[[Category:Opencaching-PL]]
[[index.php?title=Category:Opencaching-DE]]
=== NOTE: INITIAL DRAFT; WORK IN PROGRESS ===
[[index.php?title=Category:Opencaching-PL]]
A user may log different actions or status information about a geocache.
User interractions with a geocache are recorded in the cache log as a log entries.  


This document describes the existing log types across Opencaching sites.
Each log entry has a type, indicating an action or a status, in addition to the user supplied log entry text.
 
All log entries generate a notification email to the cache owner. Notification may be individual (per log) or digest.
 
 
''This document describes the existing log types across Opencaching sites.''


== Log types matrix ==
== Log types matrix ==
Line 15: Line 20:
| rowspan="2" |'''Type'''
| rowspan="2" |'''Type'''
| rowspan="2" |'''Usage'''
| rowspan="2" |'''Usage'''
| colspan="2" |'''OKAPI'''
| colspan="2" |'''Icons'''
| colspan="2" |'''Icons'''
| rowspan="2" |'''Notes'''
| rowspan="2" |'''Notes'''
| rowspan="2" |'''<small>GC equivalent</small>'''<ref group="GC compatibility">Information provided for third party application compatibility.</ref>
|-  style="background-color:#CCCCCC"
|-  style="background-color:#CCCCCC"
|'''API string'''
|'''Submittable'''
|'''OCPL'''
|'''OCPL'''
|'''OCDE'''
|'''OCDE'''
Line 24: Line 33:
|-
|-
| 1
| 1
|[[Log:Found it|Found it]]
|All
|Found it
|Found it
|All
|yes
|
|[[File:Found.svg]]
|
|
|
|
|<small>Found it</small>
|-
|-
| 2
| 2
|[[Log:Didn't find it|Didn't find it]]
|All
|Didn't find it
|Didn't find it
|All
|yes
|
|[[File:Dnf.svg]]
|
|
|
|
|<small>Didn't find it</small>
|-
|-
| 3
| 3
|[[Log:Comment|Comment]]
|All
|Comment
|Comment
|All
|yes
|
|[[File:Note.svg]]
|
|
|i.e. WRITE NOTE
|i.e. WRITE NOTE
|<small>Write Note</small>
|-
|-
| 4
| 4
|[[Log:Moved|Moved]]
|OCPL
|Moved
|Moved
|OCPL
|no
|[[File:Moved.svg]]
|
|
|''Specific to "moving cache"''
|
|
|''Specific to "moving cache"''
|-
|-
| 5
| 5
|[[Log:Needs maintenance|Needs maintenance]]
|OCPL
|Needs maintenance
|Needs maintenance
|OCPL
|no
|[[File:Need-maintenance.svg]]
|
|
|
|
|OCDE and OKAPI logs have a "needs maintenance" flag
* OCDE and OKAPI logs have a "needs maintenance" flag
* OKAPI for OCDE Submit via Comment + needs_maintenance2=true
|<small>Needs maintenance</small>
|-
|-
| 6
| 6
|[[Log:Maintenance performed|Maintenance performed]]
|OCPL
|Maintenance performed
|Maintenance performed
|OCPL
|no
|[[File:Made-maintenance.svg]]
|
|
|
|
|OCDE and OKAPI logs have a "cache is ok" flag
* OCDE and OKAPI logs have a "cache is ok" flag.
* OCPL - all users may perform maintenance
* OKAPI issue #548
|<small>Owner maintenance</small>
''<small>(GC allows only maintenance by cache owner)</small>''
|-
|-
| 7
| 7
|[[Log:Attended|Attended]]
|All
|Attended
|Attended
|All
|yes
|
|[[File:Attend.svg]]
|
|
|
|
|<small>Attended</small>
|-
|-
| 8
| 8
|Will attend
|[[Log:Will attend|Will attend]]
|All
|All
|"Will attend
|yes
|[[File:Will_attend.svg]]
|
|
|
|
|
|<small>Will attend</small>
|-
|-
|9
|9
|[[Log:Archived|Archived]]
|All
|Archived
|Archived
|All
|yes
|
|[[File:Trash.svg]]
|
|
|
|
|<small>Archived</small>
|-
|-
|10
|10
|Ready to be found
|[[Log:Ready to be found|Ready to be found]]
|All
|All
|
|Ready to search
|yes
|[[File:Published.svg]]
|
|
|i.e. ENABLED
|i.e. ENABLED
OCDE=Available
OCDE=Available
|<small>Enabled</small>
''<small>(must be published)</small>''
|-
|-
|11
|11
|[[Log:Temporarily unavailable|Temporarily unavailable]]
|All
|Temporarily unavailable
|Temporarily unavailable
|All
|yes
|
|[[File:Temporary.svg]]
|
|
|i.e. DISABLED
|i.e. DISABLED
|<small>Disabled</small>
|-
|-
|12
|12
|[[Log:OC Team comment|OC Team comment]]
|OCPL
|OC Team comment
|OC Team comment
|OCPL
|no
|[[File:Octeam.svg]]
|
|
|
|
|OCDE and OKAPI logs have an "OC team entry" flag
* OCDE and OKAPI logs have an "OC team entry" flag
|<small>Reviewer note</small>
|-
|-
|13
|13
|[[Log:Locked|Locked]]
|OCDE
|Locked
|Locked
|OCDE
|no
|
|
|
|
|<small>''OCPL not implemented, but equivalent functionality is status=BLOCKED''</small>
|
|
|-
|-
|14
|14
|[[Log:Locked, invisible|Locked, invisible]]
|OCDE
|Locked, invisible
|Locked, invisible
|OCDE
|no
|
|
|
|
|
* OCDE maps to "Locked" in output
|
|
|}
|}
<references group="GC compatibility" />

Latest revision as of 20:01, 20 June 2026

index.php?title=Category:Assigned numbers index.php?title=Category:Cache index.php?title=Category:Log index.php?title=Category:Opencaching-DE index.php?title=Category:Opencaching-PL User interractions with a geocache are recorded in the cache log as a log entries.

Each log entry has a type, indicating an action or a status, in addition to the user supplied log entry text.

All log entries generate a notification email to the cache owner. Notification may be individual (per log) or digest.


This document describes the existing log types across Opencaching sites.

Log types matrix

ID Type Usage OKAPI Icons Notes GC equivalent[GC compatibility 1]
API string Submittable OCPL OCDE
1 Found it All Found it yes Found it
2 Didn't find it All Didn't find it yes Didn't find it
3 Comment All Comment yes i.e. WRITE NOTE Write Note
4 Moved OCPL Moved no Specific to "moving cache"
5 Needs maintenance OCPL Needs maintenance no
  • OCDE and OKAPI logs have a "needs maintenance" flag
  • OKAPI for OCDE Submit via Comment + needs_maintenance2=true
 Needs maintenance
6 Maintenance performed OCPL Maintenance performed no
  • OCDE and OKAPI logs have a "cache is ok" flag.
  • OCPL - all users may perform maintenance
  • OKAPI issue #548
 Owner maintenance

(GC allows only maintenance by cache owner)

7 Attended All Attended yes Attended
8 Will attend All "Will attend yes Will attend
9 Archived All Archived yes Archived
10 Ready to be found All Ready to search yes i.e. ENABLED

OCDE=Available

Enabled

(must be published)

11 Temporarily unavailable All Temporarily unavailable yes i.e. DISABLED Disabled
12 OC Team comment OCPL OC Team comment no
  • OCDE and OKAPI logs have an "OC team entry" flag
 Reviewer note
13 Locked OCDE Locked no OCPL not implemented, but equivalent functionality is status=BLOCKED
14 Locked, invisible OCDE Locked, invisible no
  • OCDE maps to "Locked" in output
  1. ↑ Information provided for third party application compatibility.
Retrieved from "https://wiki.opencaching.eu/index.php?title=Log_types&oldid=758"