Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions partner_catalog/api/v1/urls.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
from partner_catalog.api.v1.views import (
CatalogCourseEnrollmentViewSet,
CatalogCourseViewSet,
CatalogEnrollmentsViewSet,
CatalogLearnerInvitationViewSet,
CatalogLearnerViewset,
PartnerCatalogViewSet,
Expand All @@ -26,6 +27,7 @@
manage_catalogs_router.register(r"learners", CatalogLearnerViewset, basename="catalog-learners")
manage_catalogs_router.register(r"courses", CatalogCourseViewSet, basename="catalog-courses")
manage_catalogs_router.register(r"invitations", CatalogLearnerInvitationViewSet, basename="catalog-learner-invitations")
manage_catalogs_router.register(r"enrollments", CatalogEnrollmentsViewSet, basename="catalog-enrollments")

courses_router = NestedDefaultRouter(manage_catalogs_router, r"courses", lookup="course")
courses_router.register(r"enrollments", CatalogCourseEnrollmentViewSet, basename="catalog-course-enrollments")
Expand Down
43 changes: 28 additions & 15 deletions partner_catalog/api/v1/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -216,21 +216,6 @@ def available_courses(self, request, **kwargs):
}
return Response(response_data)

@action(detail=True, methods=["get"], url_path="enrollments")
def enrollments(self, request, pk=None):
"""Get all course enrollments for this catalog."""
enrollments = CatalogCourseEnrollment.objects.filter(
catalog_course__catalog_id=pk
).select_related("user", "catalog_course", "catalog_course__course_overview")

page = self.paginate_queryset(enrollments)
if page is not None:
serializer = CatalogCourseEnrollmentSerializer(page, many=True)
return self.get_paginated_response(serializer.data)

serializer = CatalogCourseEnrollmentSerializer(enrollments, many=True)
return Response(serializer.data)


class CatalogLearnerViewset(InjectNestedFKMixin, viewsets.ReadOnlyModelViewSet):
"""
Expand Down Expand Up @@ -504,3 +489,31 @@ def get_queryset(self):
qs = self.queryset
course_pk = self.kwargs.get("course_pk")
return qs.filter(catalog_course_id=course_pk) if course_pk else qs


class CatalogEnrollmentsViewSet(viewsets.ReadOnlyModelViewSet):
"""
ViewSet for retrieving enrollments across all courses in a specific corporate partner catalog.

This view provides read-only access to all user enrollments associated with a given PartnerCatalog,
including user details and course enrollment information. Useful for administrators to list and audit
active or historical enrollments for compliance and support purposes.
"""

serializer_class = CatalogCourseEnrollmentSerializer
permission_classes = [IsPartnerCatalogManager]
filter_backends = [DjangoFilterBackend, filters.SearchFilter, filters.OrderingFilter]

filterset_fields = ["active", "user"]
search_fields = ["user__username", "user__first_name", "user__last_name", "user__email"]
ordering_fields = ["id"]
ordering = ["-id"]

def get_queryset(self):
catalog_pk = self.kwargs["catalog_pk"]
return (
CatalogCourseEnrollment.objects.filter(
catalog_course__catalog_id=catalog_pk
)
.select_related("user", "catalog_course", "catalog_course__course_overview")
)