CourseApi.md

\CourseApi

All URIs are relative to http://localhost

Method	HTTP request	Description
get_course	GET /api/courses/{course_slug}	Get course
get_course_lesson	GET /api/courses/{course_slug}/lessons/{lesson_slug}	Get lesson
save_last	PUT /api/courses/{course_slug}/last	Save last viewed item
update_course	PUT /api/courses/{course_slug}	Update course
update_course_lesson	PUT /api/courses/{course_slug}/lessons/{lesson_slug}	Update lesson

get_course

models::DetailedCourse get_course(course_slug) Get course

Parameters

Name	Type	Description	Required	Notes
course_slug	String	Course slug	[required]

Return type

models::DetailedCourse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_course_lesson

models::Lesson get_course_lesson(course_slug, lesson_slug) Get lesson

Parameters

Name	Type	Description	Required	Notes
course_slug	String	Course slug	[required]
lesson_slug	String	Lesson slug	[required]

Return type

models::Lesson

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

save_last

models::Course save_last(course_slug, last_item) Save last viewed item

Saves the last viewed lesson or challenge in the specified course

Parameters

Name	Type	Description	Required	Notes
course_slug	String	Course slug	[required]
last_item	LastItem		[required]

Return type

models::Course

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_course

models::CreateSuccess update_course(course_slug, update_course_request) Update course

If course is not found, it will be created

Parameters

Name	Type	Description	Required	Notes
course_slug	String	Course slug	[required]
update_course_request	UpdateCourseRequest		[required]

Return type

models::CreateSuccess

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_course_lesson

models::CreateSuccess update_course_lesson(course_slug, lesson_slug, update_lesson_request) Update lesson

If lesson is not found, it will be created

Parameters

Name	Type	Description	Required	Notes
course_slug	String	Course slug	[required]
lesson_slug	String	Lesson slug	[required]
update_lesson_request	UpdateLessonRequest		[required]

Return type

models::CreateSuccess

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]