Get Calendar Events as JSON

clueo8 · January 31, 2019, 12:47pm

I’m trying to figure out a way to get my nextcloud calendar events returned in a json format. I’ve read through the documentation, but I’m not sure if I’m looking in the right place. I’m trying this:

https://user:pass@mynextcloud/ocs/v1.php/apps/calendar?format=json

But I can’t seem to get anywhere. Is there a service endpoint or other way to do this? I’m looking into using JavaScript/Ajax to parse through my calendar.

Thanks in advance.

Bernie_O · January 31, 2019, 1:51pm

I don‘t know how to retrieve single events in json format. But you can get complete calendars in jcal format with (jcal = json for iCalendars):

https://NEXTCLOUD.URL/remote.php/dav/calendars/USERNAME/URI?export&accept=jcal

where URI for the desired calendar can be looked up in the database table oc_calendars (your table prefix might differ from oc_).
Of course you also need to authenticate with username and password in the request - I would not put the user credentials in the URL though.

clueo8 · January 31, 2019, 2:15pm

That’s the WebDav url I believe. It appears to give me this message when attempting to access it via browser:

This is the WebDAV interface. It can only be accessed by WebDAV clients such as the Nextcloud desktop sync client.

I’m able to curl forcing the method to be PROPFIND, but I’m not seeing a list of events in json format…

Bernie_O · January 31, 2019, 3:43pm

Yes, this is the WebDAV-URL, but the export function works with a http client. Are you sure you appended the query-string for the get-request properly?
If I enter that link (including the query-string ?export&accept=jcal!) in a browser or request it via curl - I get a calender in json format. I know that at least the export function as an ics-file (without &accept=jcal) works since Nextcloud 9.0
Without the query-string I also get „This is the webdav interface…“

clueo8 · January 31, 2019, 4:24pm

I believe I got this working. I was looking at the principleuri field instead of uri in the database… The uri was called “personal”.

The json response is huge, is there any documentation on this export param or any other query parameters to reduce the size of the json response? I can’t seem to find any documentation on it.

Bernie_O · January 31, 2019, 5:00pm

You could add a start and end date.
I don‘t know of any documentation except the comments in the code:

github.com

nextcloud/3rdparty/blob/master/sabre/dav/lib/CalDAV/ICSExportPlugin.php#L13-L41


      
          use Sabre\VObject;
          
          /**
           * ICS Exporter.
           *
           * This plugin adds the ability to export entire calendars as .ics files.
           * This is useful for clients that don't support CalDAV yet. They often do
           * support ics files.
           *
           * To use this, point a http client to a caldav calendar, and add ?expand to
           * the url.
           *
           * Further options that can be added to the url:
           *   start=123456789 - Only return events after the given unix timestamp
           *   end=123245679   - Only return events from before the given unix timestamp
           *   expand=1        - Strip timezone information and expand recurring events.
           *                     If you'd like to expand, you _must_ also specify start
           *                     and end.
           *
           * By default this plugin returns data in the text/calendar format (iCalendar

This file has been truncated. show original

IMHO there is actually a mistake: in line 20 it should probably be ?export (and not ?expand)
I hope that helps

clueo8 · January 31, 2019, 8:28pm

Thanks for this.