ibl-data-manager (3.59.0-ai-plus)
API for iblai
Request
API View for retrieving pathway suggestions for a specific user.
This endpoint allows users to view pathway suggestions that have been made for them, with support for filtering by platform and pagination.
Query Parameters: user (str, required): Username or user ID to retrieve suggestions for platform_key (str, optional): Filter suggestions by platform key platform_org (str, optional): Filter suggestions by platform organization 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: Retrieve a paginated list of pathway suggestions for a user
Returns: GET: A paginated JSON response containing pathway suggestions: { "count": 10, "next": "https://example.com/api/catalog/suggestions/pathway/user/?page=2", "previous": null, "results": [ { "id": 123, "user_id": 456, "username": "student1", "name": "Student Name", "platform_key": "platform1", "accepted": false, "visible": true, "created": "2023-06-15T14:30:00Z", "modified": "2023-06-15T14:30:00Z", "metadata": {}, "pathway_id": "pathway-v1:org+pathway+run", "pathway_uuid": "12345678-1234-5678-1234-567812345678", "pathway_name": "Data Science Pathway", "pathway_platform_key": "platform1" }, ... ] }
Error Responses: 400 Bad Request: If required parameters are missing or invalid, or if suggestion retrieval 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, IsPlatformAdminReadOnly, or IsEdxUserReadOnly permission
- Users can view their own suggestions
- Platform admins can view suggestions for users in their platform (read-only)
- DM admins can view all suggestions
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/catalog/suggestions/pathway/user/
https://base.manager.iblai.app/api/catalog/suggestions/pathway/user/
- 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/suggestions/pathway/user/?email=user%40example.com&page=0&page_size=0&platform_key=string&platform_org=string&sort=-id&user_id=0&username=string' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "count": 0, "next_page": "http://example.com", "previous_page": "http://example.com", "results": [ { … } ] }
Request
API View for managing program suggestions.
This endpoint allows administrators to view, create, update, and delete program suggestions for users within a platform.
Query Parameters (GET): platform_key (str, required): The platform to retrieve suggestions for platform_org (str, optional): The organization identifier for the platform query (str, optional): Search term to filter suggestions sort (str, optional): Field to sort results by (default: '-id') department_mode (bool, optional): Filter suggestions by department admin access page (int, optional): Page number for pagination page_size (int, optional): Number of items per page
Methods: GET: Retrieve a paginated list of program suggestions for a platform POST: Create or update a program suggestion DELETE: Remove a program suggestion
Request Body (POST): A JSON object containing:
- platform_key (str, required): The platform for the suggestion
- program_key (str, required): The program key to suggest
- user_id (str/int, required): The user to suggest the program to
- accepted (bool, optional): Whether the suggestion is accepted
- visible (bool, optional): Whether the suggestion is visible
- metadata (dict, optional): Additional suggestion metadata
Query Parameters (DELETE): suggestion_id (int, required): The ID of the suggestion to delete
Returns: GET: A paginated JSON response containing program suggestions: { "count": 10, "next": "https://example.com/api/catalog/suggestions/program/manage/?page=2", "previous": null, "results": [ { "id": 123, "user_id": 456, "username": "student1", "name": "Student Name", "platform_key": "platform1", "accepted": false, "visible": true, "created": "2023-06-15T14:30:00Z", "modified": "2023-06-15T14:30:00Z", "metadata": {}, "program_key": "program-v1:org+program+run", "program_name": "Data Science Program" }, ... ] }
POST: A JSON response containing the created/updated suggestion: { "id": 123, "user_id": 456, "username": "student1", "name": "Student Name", "platform_key": "platform1", "accepted": false, "visible": true, "created": "2023-06-15T14:30:00Z", "modified": "2023-06-15T14:30:00Z", "metadata": {}, "program_key": "program-v1:org+program+run", "program_name": "Data Science Program" }
DELETE: A success response with status 200
Error Responses: 400 Bad Request: If required parameters are missing or invalid, or if suggestion operations fail 401 Unauthorized: If the user is not authenticated 403 Forbidden: If the user does not have permission to manage suggestions 500 Internal Server Error: If an unexpected error occurs
Access Control:
- Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
- Platform admins can manage suggestions for their platform
- Department admins can manage suggestions for their departments
- DM admins can manage all suggestions
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/catalog/suggestions/program/manage/
https://base.manager.iblai.app/api/catalog/suggestions/program/manage/
- 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/suggestions/program/manage/?department_mode=true&page=0&page_size=0&platform_key=string&platform_org=string&query=string&sort=-id' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "count": 0, "next_page": "http://example.com", "previous_page": "http://example.com", "results": [ { … } ] }
Request
API View for managing program suggestions.
This endpoint allows administrators to view, create, update, and delete program suggestions for users within a platform.
Query Parameters (GET): platform_key (str, required): The platform to retrieve suggestions for platform_org (str, optional): The organization identifier for the platform query (str, optional): Search term to filter suggestions sort (str, optional): Field to sort results by (default: '-id') department_mode (bool, optional): Filter suggestions by department admin access page (int, optional): Page number for pagination page_size (int, optional): Number of items per page
Methods: GET: Retrieve a paginated list of program suggestions for a platform POST: Create or update a program suggestion DELETE: Remove a program suggestion
Request Body (POST): A JSON object containing:
- platform_key (str, required): The platform for the suggestion
- program_key (str, required): The program key to suggest
- user_id (str/int, required): The user to suggest the program to
- accepted (bool, optional): Whether the suggestion is accepted
- visible (bool, optional): Whether the suggestion is visible
- metadata (dict, optional): Additional suggestion metadata
Query Parameters (DELETE): suggestion_id (int, required): The ID of the suggestion to delete
Returns: GET: A paginated JSON response containing program suggestions: { "count": 10, "next": "https://example.com/api/catalog/suggestions/program/manage/?page=2", "previous": null, "results": [ { "id": 123, "user_id": 456, "username": "student1", "name": "Student Name", "platform_key": "platform1", "accepted": false, "visible": true, "created": "2023-06-15T14:30:00Z", "modified": "2023-06-15T14:30:00Z", "metadata": {}, "program_key": "program-v1:org+program+run", "program_name": "Data Science Program" }, ... ] }
POST: A JSON response containing the created/updated suggestion: { "id": 123, "user_id": 456, "username": "student1", "name": "Student Name", "platform_key": "platform1", "accepted": false, "visible": true, "created": "2023-06-15T14:30:00Z", "modified": "2023-06-15T14:30:00Z", "metadata": {}, "program_key": "program-v1:org+program+run", "program_name": "Data Science Program" }
DELETE: A success response with status 200
Error Responses: 400 Bad Request: If required parameters are missing or invalid, or if suggestion operations fail 401 Unauthorized: If the user is not authenticated 403 Forbidden: If the user does not have permission to manage suggestions 500 Internal Server Error: If an unexpected error occurs
Access Control:
- Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
- Platform admins can manage suggestions for their platform
- Department admins can manage suggestions for their departments
- DM admins can manage all suggestions
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/catalog/suggestions/program/manage/
https://base.manager.iblai.app/api/catalog/suggestions/program/manage/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/suggestions/program/manage/?department_mode=true&page=0&page_size=0&platform_key=string&platform_org=string&query=string&sort=-id' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"platform_key": "string",
"platform_org": "string",
"program_key": "string",
"user_id": "string",
"username": "string",
"email": "user@example.com",
"suggested_by": "string",
"direct": true,
"department_mode": false,
"accepted": false,
"visible": true,
"metadata": {
"property1": null,
"property2": null
}
}'{ "id": 0, "user_id": 0, "username": "string", "name": "string", "platform_key": "string", "accepted": true, "visible": true, "created": "2019-08-24T14:15:22Z", "modified": "2019-08-24T14:15:22Z", "metadata": { "property1": null, "property2": null }, "program_key": "string", "program_name": "string" }