fix: Catalog hidden courses are excluded by default
fix: use year_of_birth instead of date_of_birth
New:
feat: course details and course statuses APIs
Course Details
GET /api/fx/courses/v1/courses?page=<pageNumber>&page_size=<pageSize>&tenant_ids=<tenantIds>&search_text=<searchText>&sort=<sortFields>
<pageNumber> (optional): page number used by pagination. If not passed, the first page will be returned
<pageSize> (optional): page size used by pagination. If not passed, it’ll be assumed as 20 records
<tenantIds> (optional): a comma-separated list of the tenant IDs to get the information for. If not provided, the API will assume the list of all accessible tenants by the user
<searchText> (optional): filter to be used against the course display name and code
<sortFields> (optional): sort the result by the given fields. The default is display_name. The value can be one or more fields, with the use of ( - ) to indicate descending sorting (id, self_paced, enrolled_count, active_count, certificates_count, display_name, org)
Examples:
The first page of the list of courses for all accessible tenants
GET /api/fx/courses/v1/courses
The first page of the list of courses for all accessible tenants, sorted by enrolled_count descending then display_name ascending
GET /api/fx/courses/v1/courses&sort=-enrolled_count,display_name
The second page of the list of courses for all accessible tenants, for those having Sh in the display name or code
GET /api/fx/courses/v1/courses?page=2&search_text=Sh
Course Statuses
GET /api/fx/statistics/v1/course_statuses/?tenant_ids=<tenantIds>
Total number of courses per status of course. There are six possible statuses, which are a composition of enrollment type (instructor-paced and self-paced) with status (ongoing, archived, and upcoming):
ongoing: instructor-paced courses that have started but not ended yet
archived: instructor-paced courses that have ended
upcoming: instructor-paced courses that have not started yet
self_ongoing: self-paced courses that have started but not ended yet
self_archived: self-paced courses that have ended
self_upcoming: self-paced courses that have not started yet
<tenantIds> (optional): a comma-separated list of the tenant IDs to get the information for. If not provided, the API will assume the list of all accessible tenants by the user
Examples:
Courses count in all accessible tenants
GET /api/fx/statistics/v1/course_statuses/
Courses count in tenants 1, 4, and 99
GET /api/fx/statistics/v1/course_statuses/?tenant_ids=1,4,99
Fixes:
New:
Course Details
Examples:
The first page of the list of courses for all accessible tenants
The first page of the list of courses for all accessible tenants, sorted by enrolled_count descending then display_name ascending
The second page of the list of courses for all accessible tenants, for those having Sh in the display name or code
Course Statuses
Total number of courses per status of course. There are six possible statuses, which are a composition of enrollment type (instructor-paced and self-paced) with status (ongoing, archived, and upcoming):
ongoing
: instructor-paced courses that have started but not ended yetarchived
: instructor-paced courses that have endedupcoming
: instructor-paced courses that have not started yetself_ongoing
: self-paced courses that have started but not ended yetself_archived
: self-paced courses that have endedself_upcoming
: self-paced courses that have not started yet<tenantIds>
(optional): a comma-separated list of the tenant IDs to get the information for. If not provided, the API will assume the list of all accessible tenants by the userExamples:
Courses count in all accessible tenants
Courses count in tenants 1, 4, and 99