Skip to content
API Reference
/
catalog
/
catalog_suggestions_course_user_retrieve

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server

https://docs.ibl.ai/_mock/apis/ibl/

https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

career

Operations

catalog

Operations

catalog_suggestions_course_manage_group_destroy

Request

API View for managing course group suggestions.

This endpoint allows administrators to view, create, and delete course suggestions for groups of users within a platform.

Query Parameters (GET): platform_key (str, required): The platform to retrieve group suggestions for platform_org (str, optional): The organization identifier for the platform query (str, optional): Search term to filter group 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 course group suggestions for a platform POST: Create or update a course group suggestion DELETE: Remove a course group suggestion

Request Body (POST): A JSON object containing:

  • platform_key (str, required): The platform for the group suggestion
  • course_id (str, required): The course ID to suggest
  • group_id (str/int, required): The group to suggest the course 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 group suggestion to delete

Returns: GET: A paginated JSON response containing course group suggestions: { "count": 5, "next": "https://example.com/api/catalog/suggestions/course/group/?page=2", "previous": null, "results": [ { "id": 123, "group_id": 789, "group_name": "Engineering Team", "platform_key": "platform1", "accepted": false, "visible": true, "created": "2023-06-15T14:30:00Z", "modified": "2023-06-15T14:30:00Z", "metadata": {}, "course_id": "course-v1:org+course+run", "course_name": "Introduction to Programming", "user_count": 25 }, ... ] }

POST: A JSON response containing the created/updated group suggestion: { "id": 123, "group_id": 789, "group_name": "Engineering Team", "platform_key": "platform1", "accepted": false, "visible": true, "created": "2023-06-15T14:30:00Z", "modified": "2023-06-15T14:30:00Z", "metadata": {}, "course_id": "course-v1:org+course+run", "course_name": "Introduction to Programming", "user_count": 25 }

DELETE: A success response with status 200

Error Responses: 400 Bad Request: If required parameters are missing or invalid, or if group suggestion operations fail 401 Unauthorized: If the user is not authenticated 403 Forbidden: If the user does not have permission to manage group suggestions 500 Internal Server Error: If an unexpected error occurs

Access Control:

  • Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
  • Platform admins can manage group suggestions for their platform
  • Department admins can manage group suggestions for their departments
  • DM admins can manage all group suggestions
Security
PlatformApiKeyAuthentication
Query
department_modeboolean

Flag to ensure department admins can call the API

Default false
pageinteger

Page number for pagination

page_sizeinteger

Number of items per page

platform_keystringnon-emptyrequired

The platform to retrieve group suggestions for

platform_orgstringnon-empty

The organization identifier for the platform

querystringnon-empty

Search term to filter group suggestions

sortstringnon-empty

Field to sort results by

Default "id"
suggestion_idintegerrequired

The ID of the group suggestion to delete

curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/suggestions/course/manage/group/?department_mode=false&page=0&page_size=0&platform_key=string&platform_org=string&query=string&sort=id&suggestion_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success - group suggestion deleted

catalog_suggestions_course_user_retrieve

Request

API View for retrieving course suggestions for a specific user.

This endpoint allows users to view course 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 course suggestions for a user

Returns: GET: A paginated JSON response containing course suggestions: { "count": 10, "next": "https://example.com/api/catalog/suggestions/course/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": {}, "course_id": "course-v1:org+course+run", "course_name": "Introduction to Programming" }, ... ] }

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
Security
PlatformApiKeyAuthentication
Query
emailstring(email)non-empty

Email to retrieve suggestions for

pageinteger

Page number for pagination

page_sizeinteger

Number of items per page

platform_keystringnon-empty

Filter suggestions by platform key

platform_orgstringnon-empty

Filter suggestions by platform organization

sortstringnon-empty

Field to sort results by

Default "-id"
userstringnon-emptyrequired

Username or user ID to retrieve suggestions for

user_idinteger

User ID to retrieve suggestions for

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/suggestions/course/user/?email=user%40example.com&page=0&page_size=0&platform_key=string&platform_org=string&sort=-id&user=string&user_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired

Total number of results

next_pagestring or null(uri)required

URL for next page of results

previous_pagestring or null(uri)required

URL for previous page of results

resultsArray of objects(CourseSuggestionDetail)required

List of course suggestions

results[].​idintegerrequired

The unique identifier for the suggestion

results[].​user_idintegerrequired

The ID of the user receiving the suggestion

results[].​usernamestringrequired

The username of the user receiving the suggestion

results[].​namestringrequired

The full name of the user receiving the suggestion

results[].​platform_keystringrequired

The platform key associated with the suggestion

results[].​acceptedbooleanrequired

Whether the suggestion has been accepted by the user

results[].​visiblebooleanrequired

Whether the suggestion is visible to the user

results[].​createdstring(date-time)required

When the suggestion was created

results[].​modifiedstring(date-time)required

When the suggestion was last modified

results[].​metadataobjectrequired

Additional metadata for the suggestion

results[].​metadata.​property name*anyadditional property
results[].​course_idstringrequired

The course ID being suggested

results[].​course_namestringrequired

The name of the course being suggested

Response
application/json
{
  "count": 0,
  "next_page": "http://example.com",
  "previous_page": "http://example.com",
  "results": [
    { … }
  ]
}

catalog_suggestions_pathway_manage_retrieve

Request

API View for managing pathway suggestions.

This endpoint allows administrators to view, create, update, and delete pathway 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 pathway suggestions for a platform POST: Create or update a pathway suggestion DELETE: Remove a pathway suggestion

Request Body (POST): A JSON object containing:

  • platform_key (str, required): The platform for the suggestion
  • pathway_id (str, required): The pathway ID to suggest
  • user_id (str/int, required): The user to suggest the pathway 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 pathway suggestions: { "count": 10, "next": "https://example.com/api/catalog/suggestions/pathway/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": {}, "pathway_id": "pathway-v1:org+pathway+run", "pathway_uuid": "12345678-1234-5678-1234-567812345678", "pathway_name": "Data Science Pathway", "pathway_platform_key": "platform1" }, ... ] }

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": {}, "pathway_id": "pathway-v1:org+pathway+run", "pathway_uuid": "12345678-1234-5678-1234-567812345678", "pathway_name": "Data Science Pathway", "pathway_platform_key": "platform1" }

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
Security
PlatformApiKeyAuthentication
Query
department_modeboolean

Filter suggestions by department admin access

pageinteger

Page number for pagination

page_sizeinteger

Number of items per page

platform_keystringnon-emptyrequired

The platform to retrieve suggestions for

platform_orgstringnon-empty

The organization identifier for the platform

querystringnon-empty

Search term to filter suggestions

sortstringnon-empty

Field to sort results by

Default "-id"
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/suggestions/pathway/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'

Responses

Bodyapplication/json
countintegerrequired

Total number of results

next_pagestring or null(uri)required

URL for next page of results

previous_pagestring or null(uri)required

URL for previous page of results

resultsArray of objects(PathwaySuggestionDetail)required

List of pathway suggestions

results[].​idintegerrequired

The unique identifier for the suggestion

results[].​user_idintegerrequired

The ID of the user receiving the suggestion

results[].​usernamestringrequired

The username of the user receiving the suggestion

results[].​namestringrequired

The full name of the user receiving the suggestion

results[].​platform_keystringrequired

The platform key associated with the suggestion

results[].​acceptedbooleanrequired

Whether the suggestion has been accepted by the user

results[].​visiblebooleanrequired

Whether the suggestion is visible to the user

results[].​createdstring(date-time)required

When the suggestion was created

results[].​modifiedstring(date-time)required

When the suggestion was last modified

results[].​metadataobjectrequired

Additional metadata for the suggestion

results[].​metadata.​property name*anyadditional property
results[].​pathway_idstringrequired

The pathway ID being suggested

results[].​pathway_uuidstringrequired

The UUID of the pathway being suggested

results[].​pathway_namestringrequired

The name of the pathway being suggested

results[].​pathway_platform_keystringrequired

The platform key associated with the pathway

Response
application/json
{
  "count": 0,
  "next_page": "http://example.com",
  "previous_page": "http://example.com",
  "results": [
    { … }
  ]
}

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com