ibl-data-manager (3.59.0-ai-plus)
API for iblai
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/catalog/eligibility/courses/
https://base.manager.iblai.app/api/catalog/eligibility/courses/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/eligibility/courses/?org=string&query=string&user_id=string&username=string' \
-H 'Authorization: YOUR_API_KEY_HERE'[ { "course_id": "string", "name": "string", "slug": "string", "org": "string" } ]
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/catalog/eligibility/courses/check/
https://base.manager.iblai.app/api/catalog/eligibility/courses/check/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/eligibility/courses/check/?course_id=string&local_only=true&org=string&user_id=string&username=string' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "property1": null, "property2": null }
Request
API View for searching course enrollments.
This endpoint allows searching for course enrollments based on various filters such as user ID, username, email, course ID, slug, organization, and platform key. Results are paginated and include detailed enrollment information.
Query Parameters: user_id (str, optional): Filter enrollments by user ID username (str, optional): Filter enrollments by username email (str, optional): Filter enrollments by user email course_id (str, optional): Filter enrollments by course ID slug (str, optional): Filter enrollments by course slug org (str, optional): Filter enrollments by organization platform_key (str, optional): Filter enrollments by platform key course_name (str, optional): Filter enrollments by course name (partial match) include_default_platform (bool, optional): Include enrollments from default platform sort (str, optional): Field to sort results by (default: '-id') page (int, optional): Page number for pagination page_size (int, optional): Number of items per page
Methods: GET: Search for course enrollments with filtering and pagination
Returns: GET: A paginated JSON response containing course enrollments: { "count": 42, "next": "https://api.example.com/api/catalog/enrollment/courses/search/?page=2", "previous": null, "results": [ { "user_id": 123, "username": "student1", "email": "student1@example.com", "course_id": "course-v1:org+course+run", "active": true, "created": "2023-01-15T10:30:00Z", "started": "2023-01-15T10:30:00Z", "ended": null, "expired": null, "metadata": {}, "name": "John Doe", "course_name": "Introduction to Data Science" }, ... ] }
Error Responses: 400 Bad Request: If required parameters are missing or if enrollment search fails 401 Unauthorized: If the user is not authenticated 403 Forbidden: If the user does not have permission to access this resource 500 Internal Server Error: If an unexpected error occurs
Access Control:
- Requires IsDMAdmin, IsEdxUserReadOnly, or IsPlatformAdminOfUserReadOnly permission
- Users can view their own enrollments
- Platform admins can view enrollments for users in their platform
- DM admins can view all enrollments
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/catalog/enrollment/courses/search/
https://base.manager.iblai.app/api/catalog/enrollment/courses/search/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/enrollment/courses/search/?course_id=string&course_name=string&email=string&include_default_platform=true&org=string&page=0&page_size=0&platform_key=string&slug=string&sort=-id&user_id=string&username=string' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "user_id": 0, "username": "string", "email": "string", "course_id": "string", "active": true, "created": "2019-08-24T14:15:22Z", "started": "2019-08-24T14:15:22Z", "ended": "2019-08-24T14:15:22Z", "expired": "2019-08-24T14:15:22Z", "metadata": null, "name": "string", "course_name": "string" }