ibl-data-manager (3.59.0-ai-plus)
API for iblai
Request
Endpoint to retrieve the credentials of a given tenant grouped by course.
This endpoint provides access to credential data grouped by course for a specific organization/tenant, with support for pagination and filtering.
Path Parameters: org (str): The organization/tenant identifier
Query Parameters: limit (int, optional): Number of results per page (default: 10) offset (int, optional): Starting position for pagination search (str, optional): Search term e.g course_id
Returns: A paginated response using the CourseCredentialSerializer format.
Error Responses: 401 Unauthorized: If the user is not authenticated 403 Forbidden: If the user does not have permission to access this data 404 Not Found: If the organization doesn't exist 500 Internal Server Error: If an unexpected error occurs
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/course-credentials/
https://base.manager.iblai.app/api/credentials/orgs/{org}/users/{user_id}/course-credentials/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/course-credentials/?page=0&page_size=0' \
-H 'Authorization: YOUR_API_KEY_HERE'- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/credentials-over-time/
https://base.manager.iblai.app/api/credentials/orgs/{org}/users/{user_id}/credentials-over-time/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/credentials-over-time/?department_id=0&end_date=string&format=json&include_main_platform=true&start_date=string' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "data": { "property1": null, "property2": null } }
Request
API View for managing uploaded images for credentials.
This endpoint allows uploading new images and retrieving existing images for use with credentials (icons, backgrounds, thumbnails, etc.).
Path Parameters: org (str): The organization/tenant identifier user_id (str): The user ID making the request
Query Parameters: query (str, required for GET): Search term to filter images by name
Methods: GET: Retrieve images matching a search query POST: Upload a new image
POST Request Body: Multipart form data containing:
- image (file, required): The image file to upload
- name (str, optional): A descriptive name for the image
Returns: GET: A JSON array of image objects: [ { "id": 123, "name": "Logo", "image": "https://example.com/media/uploaded_images/logo.png" }, { "id": 124, "name": "Background", "image": "https://example.com/media/uploaded_images/background.jpg" }, ... ]
POST: A JSON object containing the uploaded image details: { "id": 125, "name": "Certificate Icon", "image": "https://example.com/media/uploaded_images/certificate-icon.png" }
Error Responses: 400 Bad Request: If the request data is invalid or missing required parameters 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 IsAdminUserOrStudentDRFMixin
- Only authenticated users with appropriate permissions can upload and retrieve images
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/images/
https://base.manager.iblai.app/api/credentials/orgs/{org}/users/{user_id}/images/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/images/' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "id": 0, "name": "string", "image": "string" }