Applies a new display order to the lessons inside one section.

Send indexes as a map of lesson id to priority. Only lessons that belong to both this course and this section are updated.

Endpoint

• Method: PATCH

• Path: /admin/courses/{course_id}/sections/{section_id}/indexes

• Edition: Core

• Controller: CourseAdminController@resetLessonIndexes

• Route source: fluent-community/Modules/Course/Http/course_api.php:50

• Controller source: fluent-community/Modules/Course/Http/Controllers/CourseAdminController.php

• Requires the course-creator permission and management access to this course.

Live sample

The request and response below were recorded against a running FluentCommunity install and then anonymised — member names, emails, avatars and post content are fictional, and long collections are trimmed to a few entries.

PATCH Reindex Course Lessons

PATCH

/admin/courses/{course_id}/sections/{section_id}/indexes

Applies a new display order to the lessons inside one section.

Controller: CourseAdminController@resetLessonIndexes
Route source: fluent-community/Modules/Course/Http/course_api.php:50

Authorizations

ApplicationPasswords

WordPress Application Passwords — use Basic auth with username:application_password.

Type

API Key (header: Authorization)

Parameters

Path Parameters

course_id*

Course ID extracted from the URL path.

Type

integer

Required

section_id*

Section ID extracted from the URL path.

Type

integer

Required

Request Body

application/json

{

  

"indexes": [

  

  

"string"

  

]

}

Responses

Successful response

Content-Type

application/json

{

  

"lessons": [

  

  

{

  

  

  

"comments_count": 0,

  

  

  

"content_type": "string",

  

  

  

"created_at": "string",

  

  

  

"expired_at": "string",

  

  

  

"featured_image": "string",

  

  

  

"id": 0,

  

  

  

"is_sticky": "string",

  

  

  

"message": "string",

  

  

  

"message_rendered": "string",

  

  

  

"meta": {

  

  

  

  

"auto_complete_on_video_end": "string",

  

  

  

  

"document_ids": [

  

  

  

  

  

{

  

  

  

  

  

  

"additionalProperties": "string"

  

  

  

  

  

}

  

  

  

  

],

  

  

  

  

"document_lists": [

  

  

  

  

  

{

  

  

  

  

  

  

"additionalProperties": "string"

  

  

  

  

  

}

  

  

  

  

],

  

  

  

  

"enable_comments": "string",

  

  

  

  

"enable_media": "string",

  

  

  

  

"enable_passing_score": "string",

  

  

  

  

"enforce_passing_score": "string",

  

  

  

  

"free_preview_lesson": "string",

  

  

  

  

"hide_result": "string",

  

  

  

  

"media": {

  

  

  

  

  

"provider": "string"

  

  

  

  

},

  

  

  

  

"passing_score": 0,

  

  

  

  

"require_video_completion": "string",

  

  

  

  

"video_completion_threshold": 0,

  

  

  

  

"video_length": 0

  

  

  

},

  

  

  

"parent_id": "string",

  

  

  

"priority": 0,

  

  

  

"privacy": "string",

  

  

  

"reactions_count": 0,

  

  

  

"scheduled_at": "string",

  

  

  

"slug": "string",

  

  

  

"space_id": "string",

  

  

  

"status": "string",

  

  

  

"title": "string",

  

  

  

"type": "string",

  

  

  

"updated_at": "string",

  

  

  

"user_id": "string"

  

  

}

  

],

  

"message": "string"

}

PATCH

/admin/courses/{course_id}/sections/{section_id}/indexes

Playground

Authorization

ApplicationPasswords

Variables

Key

Value

course_id*

section_id*

Body

Samples

Powered by VitePress OpenAPI