Course Request API

@Lindsey Bryant
While this is a known gap for the API, I don't currently have course request endpoints in my near-term plans. If there is a specific endpoint or two that would solve a use case, then i have a better chance of fitting that in somewhere.

@Lindsey Bryant you can probably get this information through an Advanced List, which may simplify the process of loading to your warehouse by using the ON API if you have access to it.

@Lindsey Bryant
There is a technical limitation that prevent the API from running SKY Lists. So, unfortunately, they are not accessible via the API.

@Lauren Henderson @Lindsey Bryant

Note: There is a Power Platform connector that can connect to any SKY API including Education. It's the Blackbaud SKY Add-ins Connector. It doesn't have built-in support for the endpoints, so building the calls is by hand, but it handles the re-authorization issue. So, it isn't necessary to limit yourself to On API when using Power Automate.

@Lindsey Bryant @Lauren Henderson

The Course Request endpoint is live now. It is list of course request records for all students, but does not include enrollment status. I've got a separate item in the backlog for connecting the request to any enrollment it might have.

@Stephen Boyle Thank you! That is great news.

@Lindsey Bryant
Hi there! Some of those fields listed are in the output already, some we are still working on and some are likely part of future endpoints.

Alternates are already listed, and enrollment status is upcoming work for us to evaluate and include if reasonable. I'll have the team look into the date and approved/rejected by at the same time. The recommendation information is not immediately planned as it is still in review.

The object currently looks like this

Here is a sample of the output from a demo db:

{
"id": 26752878,
"user": {
"id": 4326571,
"email": "abby@alex.com",
"first_name": "Abby",
"last_name": "Alex",
"maiden_name": "",
"middle_name": "",
"preferred_name": "",
"prefix": "",
"suffix": ""
},
"course": {
"id": 90859,
"name": "20th Century Propaganda",
"course_code": "5566",
"description": "Since the end of the Cold War and the rise of the internet, propaganda has never been so active in our modern societies. Propaganda is a neutral term yet has acquired along the years a negative tone. Nevertheless, as a paradox, no organized human societies could function without propaganda. This course intends to provide students with an approach to Propaganda and Information/communication systems.",
"length": 1,
"credits": 0.0,
"school_level": {
"id": 453
},
"school_year": "2024 - 2025"
},
"start_term": {
"id": 71985,
"name": "1st Semester"
},
"preference": 2,
"status": "Pending",
"note": "",
"alternates": [{
"course": {
"id": 94490,
"name": "Advanced Thermodynamics",
"course_code": "6987",
"description": "This course is not for the faint of heart. It will use all of the concepts learned in BOTH Advanced Placement Physics and Calculus BC.",
"length": 1,
"credits": 0.0,
"school_level": {
"id": 453
},
"school_year": "2024 - 2025"
},
"start_term": {
"id": 71985,
"name": "1st Semester"
},
"preference": 1
}]
}

@Lindsey Bryant, @Lauren Henderson, @Nick Marchese

The GET Academics course requests endpoint now has additional filters and fields.

New filters
- status - accepts: Pending, Approved, Denied
- enrollment_status - accepts: NotEnrolled, Enrolled, Dropped

New fields
- request_date
- requested_by
- reviewer
- enrollment_status
- filled_by_alternate

Also, see the ChangeLog.

@Lindsey Bryant

BTW, there is a bug with the alternates array (it returns blank). It will be corrected in the 4/8 release.

@Lindsey Bryant
The alternates issue was correct a in the 4/8 release. And I checked that alternates are returned for the demo db via the Try It Console. The type column indicates recommendations vs requests. All the records for this endpoints are request records. There will be a separate endpoint for recommendations. The type column also has a required state - I'll look into when that is assigned.

@Lindsey Bryant
Looks like there is a bug with the year filter. It is using ID instead of label (e.g. “2025-2026”). I'll get it updated to use either, but you can look up the ID for next year and pass that in for now.