Telling when a course is unavailable in the Enterprise API

Description

Some info to add to the Enterprise API guide:

A customer asked:

Since edX courses expire and become unavailable for enrollment, through the API catalog, is there an attribute that we can use to identify such courses and can automate the process to remove these courses automatically from our Your Learning platform ?

And replied:

The first signal that a course is not available is that it is no longer included in the API response. As we discussed early-on in the integration effort, it is important to compare the current set of edX courses in the Your Learning system versus the new set of edX courses received from the API. In addition, there are some finer scenarios which can be determined using some of the course metadata fields included in the API response which can be used to determine if a course is available:

  • If a course has an empty "course_runs" list, the course is technically not currently available

  • If a specific course run has an empty "seats" list, the course run is technically not currently avaialble

  • If a specific course run's availability attribute value is anything other than "Current", the course run is technically not currently available

  • If a specific course run's "enrollment_end" attribute value is populated, and it has passed, the course run is technically not currently available

  • If a specific course run's "end" attribute value has passed, the course run is technically not currently available

Steps to Reproduce

None

Current Behavior

None

Expected Behavior

None

Reason for Variance

None

Release Notes

None

User Impact Summary

None
Your pinned fields
Click on the next to a field label to start pinning.

Assignee

Grant Goodman

Reporter

Grant Goodman

Labels