Add the ability for the Calendar Entity Provider to return a detailed response when in list mode

Description

In the current entity provider, the description of an event is inside the CalendarEventDetails object, which is only accessible once you have the eventId. This was designed on purpose to allow for a faster and leaner response when in list mode then drilling into the details.

However sometimes it is useful to have the full details up front so that you don't need to make subsequent multiple requests to get the details for each event.

Combined with the recent time range params that were added (SAK-31206), you can request the events for a given day. If that day had 5 events, you would need to make 5 subsequent requests to get the descriptions for each.

This tickets adds an optional detailed param that if true, will return the full detailed object instead of the summary. Defaults to false to maintain backwards compatibility.

Activity

Show:

Steve Swinsburg September 1, 2016 at 8:52 AM

That is actually an empty response. You need to add data to the calendar tool in that site first

Neal Caidin August 24, 2016 at 2:16 PM

Both URL patterns return the same results
{"entityPrefix": "calendar", "calendar_collection": [

]}

using :
https://trunk-oracle.nightly.sakaiproject.org/direct/calendar/site/SITE_ID.json
https://trunk-oracle.nightly.sakaiproject.org//direct/calendar/site/SITE_ID.json?detailed=true

Setting this to Verified.

Neal Caidin August 24, 2016 at 2:14 PM

Okay, I missed that earlier comment with the original and new. Thanks.

Neal Caidin August 24, 2016 at 2:13 PM

What's the Test Plan for this one? Does it need to be tested by a developer?

Steve Swinsburg June 13, 2016 at 4:41 PM

Yeah would be nice to have in 11 to support the widget work.

Fixed

Details

Priority

Fix versions

Components

Assignee

Reporter

Created June 11, 2016 at 2:15 AM
Updated March 23, 2022 at 3:02 PM
Resolved June 11, 2016 at 8:25 AM