Community Group Rosters Beta API

Lindsey Bryant

Good morning! Has anyone tried to use the new BETA API for Community Group Rosters?

Our groups are setup as “Continuous”, meaning they are created once and are valid for multiple school years. I found that if your community group isn't setup to a specific academic year, nothing comes back.

I ran the API first with no results and no filters. I then created a new group, made it active for 1 year, and ran the API again. I now get a result of my new group but not the continuous groups. Based off the API guide, I think this is expected but I would argue is a bit of a miss. @Stephen Boyle any chance this may be adjusted to also pull back continuous groups?

Stephen Boyle

@Lindsey Bryant
Good catch. This is my unfamiliarity with community group features raising its head. I will get this adjusted to return the “Continuous” community groups as well as the “Yearly” groups. Thank you for the feedback and stay tuned.

Eric Eskildsen

@Stephen Boyle I see this endpoint is still in beta….Is there any update?

It doesn't work for the 3 schools I've tried it with so far. The output looks like this:

[null, null, null, null … ]

Excited for this endpoint….It will make certain extracts a lot simpler.

Stephen Boyle

@Eric Eskildsen
This endpoint works when I run it in the Try It Console.

I'd like to track this as a support ticket, which @Todd DeSchuiteneer can help with. Meanwhile, please give me an example school and year that you ran this for. I can start looking into it.

Eric Eskildsen

@Stephen Boyle D'OH. I'm sorry, Stephen. I was running this through an internal tool that expects the SKY response to have “count” and “value” properties. This endpoint apparently doesn't. My mistake! It works when I make the raw call. Which is great as this will simplify some of our pulls quite a bit. Noted for my future reference.

Eric Eskildsen

@Stephen Boyle Well, I may have spoken too soon….Data is coming through now, but `roster` is an empty array for all the schools. This is with a raw API call now, not piping through any tools. I'll send you the names of the schools.

Todd DeSchuiteneer

@Eric Eskildsen Thanks for posting this issue. I just had a chance to test and confirm the rosters do not come through in the results as expected. I will open a support ticket for us and have our dev team address the issue. We apologize for the inconvenience in the interim.

Eric Eskildsen

@Todd DeSchuiteneer Thanks Todd!

Lindsey Bryant

@Stephen Boyle
Any updates on this returning continuous rosters for groups? I tried it again and see it's still an issue. Would it be helpful for me to submit a support ticket?

Stephen Boyle

@Lindsey Bryant
We started a new sprint today, and this item got started today. Best case is a fix for this Tuesday.

We have a support ticket for this, but if you submit one too you will be notified automatically when we mark it fixed. If Support adds your ticket to this bug (3177539).

Stephen Boyle

@Eric Eskildsen
@Lindsey Bryant
The latest release should have cleared up the empty roster issue.

That said, I am seeing some duplicate sections (with different section IDs) for some community groups. There may be some inactive sections showing or some bad data in our demo db. I have that in the backlog, but I wanted to let you know the roster arrays should be correct for the correct section of a community group.

Lindsey Bryant

@Stephen Boyle
Thanks for the heads up. I saw it in the release notes today and it's on my list to review and ensure the continuous groups are coming back as expected. I appreciate the follow up and all the hard work you and your team are doing.

Lindsey Bryant

@Stephen Boyle I did confirm we are also seeing the duplicate section data for the community group. Our groups are setup as continuous groups. The same offeringid is on both arrays, but I do see two separate section_ids.

I also wanted to point out that continuous groups appear to have a different body response compared to the example provided in the documentation. For example, I do not have the enrolldate, departdate, status, enrollment_type that's under RosterUsers. It doesn't impact anything, but maybe something worth adding to the documentation that these arrays won't be returned due to how the group is configured.

Lindsey Bryant

@Stephen Boyle I dove into this a bit more this morning and compared it to some advanced lists I had prior to the API being released. Unfortunately, there are quite a few issues for us with our continuous groups that are configured. Support Case # 019959389 has been submitted.

For anyone that is reviewing this thread, this is what I've found so far:

Issues:

1. School_year (Year object array and it’s data points) are not included compared to he example in the API documentation.
2. Rosters array is missing:
   1. Enroll_date
   2. Depart_date
   3. Status
3. The subarray for “Leader” is always showing “false” when users are marked as leaders within the configuration
4. We are getting three top level arrays back (three unique section_ids), which I believe is for each trimester we have configured with the school year. However, the user array is only showing for the current term.