V1::LessonsProgressesController
Lessons Progresses
create
Create an lesson_progress
URL
POST /enrollments/:enrollment_id/lessons_progressesParâmetros obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| enrollment_id | Integer | Identifier of the Enrollment object |
| lesson_progress | Hash | The lesson progress to create |
| lesson_progress[lesson_id] | Integer | Identifier of the Lesson object |
| lesson_progress[completed] | Boolean | Says if the lesson progress is completed |
Parâmetros opcionais
| Nome | Tipo | Descrição |
|---|---|---|
| lesson_progress[progress] | Float | The ExamLesson or ContentLesson progress. Required if lesson_progress[completed] is false. |
| lesson_progress[grade] | Float | The grade of the ExamLesson object. Required if #lesson is an ExamLesson and lesson_progress[completed] is true. |
| lesson_progress[created_at] | DateTime | Creation date. Passing this attribute implies to not run object's callbacks |
| lesson_progress[current_video_time] | Integer | Current video time of lesson |
show
View an lesson_progress
URL
GET /lessons_progresses/:idParâmetros obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| id | Integer | Identifier the lesson_progress |
Objeto resposta
| lesson_progress | The requested lesson_progress |
index
View list of all lessons_progresses
URL
GET /enrollments/:enrollment_id/lessons_progresses or /students/:student_id/lessons_progresses or /school_products/:school_product_id/lessons_progressesParâmetros obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| enrollment_id | Integer | Identifier of the Enrollment object |
| student_id | Integer | Identifier of the Student object |
| school_product_id | Integer | Identifier of the SchoolProduct object |
Parâmetros opcionais
| Nome | Tipo | Descrição |
|---|---|---|
| page | String | The desired page of results |
| per_page | String | How many objects per page (only works when page is provided) |
Response Fields
| Nome | Tipo | Descrição |
|---|---|---|
| lessons_progresses | Array<LessonProgress> | List of lessons progresses |
update
Updates an lesson_progress
URL
PUT/PATCH /lessons_progresses/:idParâmetros obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| id | Integer | Identifier the lesson_progress |
| lesson_progress | Hash | The lesson progress to create |
Parâmetros opcionais
| Nome | Tipo | Descrição |
|---|---|---|
| lesson_progress[completed] | Boolean | Says if the lesson progress is completed |
| lesson_progress[progress] | Float | The ExamLesson or ContentLesson progress. Required if lesson_progress[completed] is false. |
| lesson_progress[grade] | Float | The grade of the ExamLesson object. Required if #lesson is an ExamLesson and lesson_progress[completed] is true. |
| lesson_progress[current_video_time] | Integer | Current video time of lesson |
Objeto resposta
| lesson_progress | The requested lesson_progress |
