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

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

ViewSet for managing mentor disclaimers.

This viewset provides endpoints for creating and managing mentor disclaimers, which are statements or information that mentors need to share with students.

Permissions:

• Platform administrators have full CRUD access
• Students have read-only access
• Unauthenticated users have no access

Endpoints:

• GET /api/orgs/{org}/users/{user_id}/disclaimers/ - List all disclaimers
• POST /api/orgs/{org}/users/{user_id}/disclaimers/ - Create a new disclaimer
• GET /api/orgs/{org}/users/{user_id}/disclaimers/{id}/ - Retrieve a specific disclaimer
• PUT/PATCH /api/orgs/{org}/users/{user_id}/disclaimers/{id}/ - Update a disclaimer
• POST /api/orgs/{org}/users/{user_id}/disclaimers/{id}/add_mentor/ - Add mentor to disclaimer
• POST /api/orgs/{org}/users/{user_id}/disclaimers/{id}/remove_mentor/ - Remove mentor from disclaimer

Query Parameters:

• Supports filtering via DjangoFilterBackend
• See DisclaimerFilterSet for available filters

Returns: List endpoint returns paginated results with disclaimer objects:

{
    "count": int,
    "next": str,
    "previous": str,
    "results": [
        {
            "id": int,
            "title": str,
            "content": str,
            "mentor": str,
            "platform": str,
            "created_at": datetime,
            "updated_at": datetime
        },
        ...
    ]
}

Detail endpoints return a single disclaimer object with the same structure

ViewSet for managing mentor disclaimers.

This viewset provides endpoints for creating and managing mentor disclaimers, which are statements or information that mentors need to share with students.

Permissions:

• Platform administrators have full CRUD access
• Students have read-only access
• Unauthenticated users have no access

Endpoints:

• GET /api/orgs/{org}/users/{user_id}/disclaimers/ - List all disclaimers
• POST /api/orgs/{org}/users/{user_id}/disclaimers/ - Create a new disclaimer
• GET /api/orgs/{org}/users/{user_id}/disclaimers/{id}/ - Retrieve a specific disclaimer
• PUT/PATCH /api/orgs/{org}/users/{user_id}/disclaimers/{id}/ - Update a disclaimer
• POST /api/orgs/{org}/users/{user_id}/disclaimers/{id}/add_mentor/ - Add mentor to disclaimer
• POST /api/orgs/{org}/users/{user_id}/disclaimers/{id}/remove_mentor/ - Remove mentor from disclaimer

Query Parameters:

• Supports filtering via DjangoFilterBackend
• See DisclaimerFilterSet for available filters

Returns: List endpoint returns paginated results with disclaimer objects:

{
    "count": int,
    "next": str,
    "previous": str,
    "results": [
        {
            "id": int,
            "title": str,
            "content": str,
            "mentor": str,
            "platform": str,
            "created_at": datetime,
            "updated_at": datetime
        },
        ...
    ]
}

Detail endpoints return a single disclaimer object with the same structure

ViewSet for managing mentor disclaimers.

This viewset provides endpoints for creating and managing mentor disclaimers, which are statements or information that mentors need to share with students.

Permissions:

• Platform administrators have full CRUD access
• Students have read-only access
• Unauthenticated users have no access

Endpoints:

• GET /api/orgs/{org}/users/{user_id}/disclaimers/ - List all disclaimers
• POST /api/orgs/{org}/users/{user_id}/disclaimers/ - Create a new disclaimer
• GET /api/orgs/{org}/users/{user_id}/disclaimers/{id}/ - Retrieve a specific disclaimer
• PUT/PATCH /api/orgs/{org}/users/{user_id}/disclaimers/{id}/ - Update a disclaimer
• POST /api/orgs/{org}/users/{user_id}/disclaimers/{id}/add_mentor/ - Add mentor to disclaimer
• POST /api/orgs/{org}/users/{user_id}/disclaimers/{id}/remove_mentor/ - Remove mentor from disclaimer

Query Parameters:

• Supports filtering via DjangoFilterBackend
• See DisclaimerFilterSet for available filters

Returns: List endpoint returns paginated results with disclaimer objects:

{
    "count": int,
    "next": str,
    "previous": str,
    "results": [
        {
            "id": int,
            "title": str,
            "content": str,
            "mentor": str,
            "platform": str,
            "created_at": datetime,
            "updated_at": datetime
        },
        ...
    ]
}

Detail endpoints return a single disclaimer object with the same structure