Get Calendar for User - Need Events for a Date Range

Lindsey Bryant
Lindsey Bryant
Third Anniversary Kudos 2 First Reply Name Dropper
in Education Management APIs

I'm looking at the Get Calendar for User API and need clarification with the date range. I'm using the following parameters ?startdate=2024-05-01&end_date=2024-10-20. When I execute the call, I'm only getting calendar events for 5/31 and 6/1. I did confirm I have events in August, September and October.

Is the end_date related to the “End Date” of the calendar event itself? If so, how do I pull data for a range of events that are between two dates without having to call this API multiple times for each individual day?

Comments

  • Jared Harbour
    Jared Harbour Blackbaud Employee
    Eighth Anniversary Kudos 1 Name Dropper Participant

    @Lindsey Bryant I did notice that the documentation on the route is lacking. The way the start date and end date are intended to work is to limit the data returned to a single month (31 days) of data if a large range is applied. So in your example I would have expected to see data from 5-1 to 6-1, so perhaps there aren't any events from the beginning of May?

    The start date and end date also allow for a smaller range, but doesn't require you to call and get events for a single day. I've seen use cases where a call is made to get a single week or even two weeks of events.

    I am going to add the correct documentation to the route today so this sort of thing won't happen in the future.

  • Lindsey Bryant
    Lindsey Bryant
    Third Anniversary Kudos 2 First Reply Name Dropper

    @Jared Harbour I originally tested the API using 05-01 to 10-20 and I only got 48 results. I have hundreds of calendar events during this date range. My hope was that the start and end date would pull all the events between the dates I provided. But I am wondering if it's using the end_date that is on the event (which would be unfortunate). It would be good to see the updated documentation so I can then help troubleshoot how we're seeing data.

  • Lindsey Bryant
    Lindsey Bryant
    Third Anniversary Kudos 2 First Reply Name Dropper

    @Jared Harbour I also wanted to point out that the requirement of having a role of Teacher, Parent or Student is also an issue. I have no need to have these roles, except to run this API.

  • Stephen Boyle
    Stephen Boyle Blackbaud Employee
    Tenth Anniversary Kudos 5 First Reply Name Dropper

    @Lindsey Bryant
    Hi. This is intended to be an “end user” endpoint. It uses the logged-in users rights to limit the output to only data valid for them. It is also returning an amalgam of things that show for a calendar, which can be a combination of games, practices, events, etc.

    This is all different from what an admin user would want. For those we are building separate endpoints for the different things that might show up on a bb calendar. And the data will bring back information across all users, not limited to the logged-in user. We already have endpoints for games, practices, class meetings, etc.

    This is ongoing work and is part of our focus on delivering Content, News, Announcement and Event data for partners and clients to use.

Categories