Academic Rosters API and Enrollment Type

Lindsey Bryant

Does anyone use the Academic Roster API and specifically the “enrollment_type” array data points? We're finding a gap on trying to identity students who are taking a class for credit or for audit. There isn't a way to get this from an advance list, you can get to it from a Sky List (but then you can't automate it to be stored in a data warehouse) and the Academic Roster AP appears to be inaccurate. Right now, it's showing we have over 350+ students taking classes for audit, which isn't possible.

I'm hoping there is another API that I can leverage but wanted to also see if others have found issues with this API and the array.

Stephen Boyle

@Lindsey Bryant
It looks like that field is essentially reporting the reverse.

Here is the enrollment type dialog:

The Grades setting is the control for the field you are referring to in the API output, translate_grades_pass_fail. The API does not accurately represent that field.

For one, the options change depending on if Earns Credits is true or false. And second, I believe “true” is representing the top option, “All grades possible”, and “false” represents the second option - which is either “Translate grades to pass/fail settings” or “Only certain grades from grade translation are allowed”.

I'll add a work item to correct this object. We will likely create a separate field to better handle the possibilities that true/false doesn't quite represent. We will discuss reversing the existing field's output or just deprecating the field.

Meanwhile, I believe if you just treat true and false as described above, instead of how the field name reads, then your results should be as you expect.

Lindsey Bryant

@Stephen Boyle
Thanks for adding that to the log. I think there is a bigger issue though. We have two enrollment types

I'm needing to identify everyone that has the “Audit” enrollment type. Here is an example of one record and the field I'm looking at that I believe is not showing the correct enrollment type:

"section": {

"id": 89787226,

"name": "BIO210 Introduction to Biology - CV",

"identifier": "CV",

"offering": {

"id": 240163,

"name": "BIO210 Introduction to Biology",

"type": {

"id": 1,

"description": "Academics"

},

"course_code": "BIO210",

"description": "",

"length": 1,

"credits": 1.0,

"school_year": "2024 - 2025"

},

"duration": {

"id": 140445,

"name": "Fall Term"

},

"school_year": {

"id": 10967,

"begin_date": "2024-07-01T00:00:00-04:00",

"current_year": true,

"end_date": "2025-06-30T00:00:00-04:00",

"published": true

},

"lead_section_id": 89787226,

"modified": "2024-10-22T09:30:45.917-04:00"

},

"roster": [

{

"user": {

"id": 5480534,

…

},

"enroll_date": "2024-12-13T00:00:00-05:00",

"depart_date": "2025-03-07T00:00:00-05:00",

"leader": {

"is_leader": false,

"is_head": false,

"is_faculty": false

},

"status": "Enrolled",

"enrollment_type": {

"id": 375,

"description": "Audit",

"earns_credit": false,

"translate_grades_pass_fail": false,

"takes_attendance": true,

"is_default": false

}

I can't reverse the logic as I would go from having around 370 records with a description of “Audit” to over 14,000K rows that have an description of “Regular”.

Stephen Boyle

@Lindsey Bryant
I see it now. I'll get this to Support.