Clarify Enterprise API docs

Description

Quicken Loans had some questions about the Enterprise API, which answered. We should revise the Enterprise API guide to clarify the field descriptions:

First: We’re trying to clarify start date meanings

  • Enrollment_start: The first date and time by which learners can enroll in this course run.

  • Course_start: The date when the course begins, in YYYY-MM-DD format.

For the two above endpoints; is enrollment_start the day and time a specific learner enrolls in a specific course? (I think the word ‘can’ is throwing me off)

Answer: For edX course metadata, enrollment_start is the date that enrollment opens for learners.

Is course_start the first day that course was available on the edX website?

Answer: For edX course metadata, course_start is the first day the course is presented for interaction on the edX website. In many cases enrollment in a course can take place prior to a course actually started.

How might this differ for an instructor led course versus self-paced?

Start dates should not differ based on pacing type, although a self-paced course oftentimes runs for an extended period, and so the course start may appear to be several months (or even a year in some cases) in the past for a given course.

Second: We’re trying to clarify the end date meaning

  • Enrollment_end: The last date and time by which learners can enroll in this course run.

  • Course_end: The date the course ends, in YYYY-MM-DD format.

Same type of question for course_end and enrollment_end; What does ‘end’ represent in a self-paced course?

Answer: For edX course metadata, course_end refers to the date at which point learners can no longer submit answers to questions and/or assessments, and enrollment_end is the date at which point learners can no longer enroll in a course. The "end" in both types of pacing is generally the same, although course teams may conduct additional activities after course end for instructor-paced courses.

Is course_end the date that course was no longer accessible on your site? Or does an enterprise set how long they want to have courses available within their catalog?

Answer: Courses are rarely taken down from edX.org – although they may no longer be open for enrollment. A learner's enrollments are always available via their dashboard. Learners are free to revisit courses after the course end date has passed. Typically enterprises are only interested in retrieving metadata for courses which are available for enrollment and/or started. Rob may have more info to share here.

How might this differ for an instructor led course versus self-paced?

I don't believe there is a difference based on pacing type for this context – Rob?

Third: We’re trying to clarify course pricing data

Is there an end point for course cost? We’re looking to provide reporting around costs based on our TMs and business areas, so we were hoping this data might exist in the API, but we can’t find anything that looks like it fits 😊.

Answer: The learner-summary data does include information about the cost of each course enrollment – I believe Jason Nolan is looking into accessing this endpoint right now.

Steps to Reproduce

None

Current Behavior

None

Expected Behavior

None

Reason for Variance

None

Release Notes

None

User Impact Summary

None
Done

Assignee

Grant Goodman

Reporter

Grant Goodman

Labels

None

Reach

None

Impact

None

Platform Area

None

Customer

None

Partner Manager

None

URL

None

Contributor Name

None

Groups with Read-Only Access

None

Actual Points

None

Category of Work

None

Platform Map Area (Levels 1 & 2)

None

Platform Map Area (Levels 3 & 4)

None

Priority

Unset