Geocaching Australia API: Submit Log
Submit a log for a geocache
Geocaching Australia API call: https://geocaching.com.au/api/services/logs/submit /
Parameters not explicitly detailed will be silently ignored if passed.
Calling the method
This method may only be called using a POST method. Any attempt to call via a GET method will return an error. The use of a POST method ensures that data are not passed by URL.
Field | Definition | Description |
consumer_key | Mandatory | The api key associated with your app. |
cache_code | Mandatory | The code that identifies the geocache to be logged. |
logtype | Mandatory | The type of log that is being created. Valid cache type and log type combinations apply as follows: Moveable -> Found it, Didn't find it, Write note, Needs Maintenance, Needs Archived, Moved Event -> Attended, Didn't find it, Write note, Will Attend, Needs Maintenance, Needs Archived Jigsaw -> Solved, Didn't find it, Write note, Needs Maintenance, Needs Archived Webcam -> Webcam Photo Taken, Didn't find it, Write note, Needs Maintenance, Needs Archived All other types -> Found it, Didn't find it, Write note, Needs Maintenance, Needs Archived Use https://geocaching.com.au/api/services/enum/logtype for a comprehensive list. |
comment | Optional | The comment to leave as the log. The Geocaching Australia tokens are supported via this method via text matching in the comment field. None of these values are validated. *FTF* to mark the geocache as First to Find by the user. *Overall Experience: n* Where n is a number between 1 and 5 to give the geocache a rating. *Recommended* to mark the geocache as recommended by the user. |
hint | Optional | The hint to leave with the log. Hint will be ignored except for a Moved log on a Moveable cache. |
when | Mandatory | The date for which the log is being submitted. Format is YYYY-MM-DD. Date must be valid and is in the users local time zone. |
password | Optional | The password is mandatory for a geocache that requires a password or is otherwise not required. |
coordinates | Optional | The co-ordinates are mandatory for a Move log on a Moveable cache, a Found it log on a Geocacher Geocache, a Solved log on a Jigsaw cache or are otherwise optional. Format is Decimal Degrees (DD) with Latitude preceeding Longitude separated by a space. eg. -37.750 144.750 |
Validation
Parameter 'method' has invalid value: This method may only be submitted by a POST method.
https://geocaching.com.au/api/services/logs/submit/
https://geocaching.com.au/api/services/logs/submit/
Parameter 'consumer_key' has invalid value: Consumer does not exist.
Parameter 'cache_code' has invalid value: This cache does not exist.
Parameter 'when' has invalid value: '2016-12-311 is not a valid date in the format YYYY-MM-DD.
Parameter 'coordinates' has invalid value: 'JUNK' latitude and longitude cannot be converted.
Where type is a Geocacher Geocache and Log Type is Found it:
Parameter 'coordinates' has invalid value: Latitude and longitude are required for this log.
Parameter 'coordinates' has invalid value: Latitude and longitude are required for this log.
Where type is a Moveable and Log Type is Moved:
Parameter 'coordinates' has invalid value: Latitude and longitude are required for a Moveable cache with a Move log.
Parameter 'coordinates' has invalid value: Latitude and longitude are required for a Moveable cache with a Move log.
Parameter 'Some geocaches, usually Locationless geocaches, can limit the number of logs a user can make. This error will be returned if the user has passed the number of logs they can make. Maximum Finds' has invalid value: You have found this cache the maximum number of times permitted.
Parameter 'logtype' has invalid value: 'Found' is not valid.
Parameter 'password' has invalid value: 'PASSCODE' is not valid for this cache codeword.
Parameter 'password' has invalid value: A codeword is required for this cache.
Parameter 'Locked Geocache' has invalid value: This geocache listing is locked for new Found It type logs.
Data Fields Returned
If the submission is successful a dictionary (array) named 'data' will be returned with the following elements.
Field | Description |
success | Boolean true if submission is successful. |
message | Your cache log entry was posted successfully. |
log_uuid | The unique log ID for this log entry. |