Academic Rosters API and Enrollment Type Array Under Users Not Accurate

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

A heads up to anyone else using the Academic Rosters API. The Enrollment Type array does not reflect accurately based off each student for the class. We recently changed to using this API and found that the “earns_credit”. We have a student that is taking the class as a repeat and they are not earning credit. However, the API returns a true value. I was able to verify this by comparing it to an advance list that returns the grades for each class a student takes. @Stephen Boyle maybe something to add to the backlog of issues?

Comments

  • Todd DeSchuiteneer
    Todd DeSchuiteneer Blackbaud Employee
    Tenth Anniversary Kudos 2 Name Dropper Participant

    Hi @Lindsey Bryant, I am following up with you on this issue on behalf of Blackbaud Support. I ran a few tests and found that the earn_credit field is returning correctly for me in a few different scenarios using enrollment types that are set to not earn credit. I am going to create and reach out to you via a support ticket to gather the specific details of your example so I can look into this further for us.

  • Stephen Boyle
    Stephen Boyle Blackbaud Employee
    Tenth Anniversary Kudos 5 Name Dropper Participant

    @Lindsey Bryant
    Hi Lindsey, I know Todd replied directly through your case, but I figured I'd add it here, too.

    The fields included under the enrollment_type object are meant to describe how that enrollment type operates, not the student's specific performance in that class. For instance, ‘use_all_grades’ has a description of “True if the enrollment type uses all the grades valid for the section. False if the grades get translated, such as if the enrollment type only uses Pass/Fail grades.” So, students with a given enrollment type could have their grades limited to pass/fail. And takes_attendance is whether the school tracks attendance for students with that enrollment type.

    Similarly, earns_credit is meant to say whether students with that enrollment type are attempting to earn credit or not (e.g. “Audit” enrollment type would have earns_credit as False).

    Hope that helps. I will see if we can make the documentation clearer, as well.

    "roster": [{
    "user": {"id": 1,"email": "JohnJr@domain.com","first_name": "John", … },
    "enroll_date": "2024-09-30T01:30:05Z",
    "depart_date": "2024-09-30T01:30:05Z",
    "leader": {"is_leader": true, "is_head": true, … },
    "status": "Enrolled",
    "enrollment_type": {
    "id": 123,
    "description": "Standard Enrollment",
    "earns_credit": true,
    "use_all_grades": true,
    "takes_attendance": true,
    "is_default": true
    }
    },{ …

Categories