courseService

courseService

• courseService
  • GetAll(queryString) ⇒ Promise.<ApiResult>
  • GetById(id) ⇒ Promise.<ApiResult>
  • GetProgress(courseId) ⇒ Promise.<ApiResult>
  • Create(body) ⇒ Promise.<ApiResult>
  • Update(body) ⇒ Promise.<ApiResult>
  • Archive(id) ⇒ Promise.<ApiResult>
  • GetModules(courseId) ⇒ Promise.<ApiResult>
  • GetModuleById(courseId, moduleId) ⇒ Promise.<ApiResult>
  • CreateModule(courseId, moduleData) ⇒ Promise.<ApiResult>
  • UpdateModule(courseId, moduleId, moduleData) ⇒ Promise.<ApiResult>
  • DeleteModule(courseId, moduleId) ⇒ Promise.<ApiResult>
  • ReorderModules(courseId, items) ⇒ Promise.<ApiResult>
  • ReorderSections(courseId, moduleId, items) ⇒ Promise.<ApiResult>
  • GetSections(courseId, moduleId) ⇒ Promise.<ApiResult>
  • OpenSection(sectionId) ⇒ Promise.<ApiResult>
  • CompleteSection(sectionId) ⇒ Promise.<ApiResult>
  • CreateSection(courseId, moduleId, sectionData) ⇒ Promise.<ApiResult>
  • UpdateSection(courseId, moduleId, sectionId, sectionData) ⇒ Promise.<ApiResult>
  • DeleteSection(courseId, moduleId, sectionId) ⇒ Promise.<ApiResult>

GetAll(queryString) ⇒ Promise.<ApiResult>

Получает список курсов с фильтрацией по регионам

Принимаемые параметры

Param	Type	Description
queryString	string	Готовая строка запроса (фильтры по регионам)

Возвращаемые данные

Returns: Promise.<ApiResult> - Список курсов

---

GetById(id) ⇒ Promise.<ApiResult>

Получает курс по идентификатору с полным списком модулей и разделов

Принимаемые параметры

Param	Type	Description
id	number	ID курса

Возвращаемые данные

Returns: Promise.<ApiResult> - Данные курса с модулями и разделами

---

GetProgress(courseId) ⇒ Promise.<ApiResult>

Получает прогресс прохождения курса текущим пользователем

Принимаемые параметры

Param	Type	Description
courseId	number	ID курса

Возвращаемые данные

Returns: Promise.<ApiResult> - Прогресс прохождения курса

---

Create(body) ⇒ Promise.<ApiResult>

Создаёт новый курс

Принимаемые параметры

Param	Type	Description
body	CreateCourseDto	Тело запроса. См. CreateCourseDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Созданный курс

---

Update(body) ⇒ Promise.<ApiResult>

Обновляет данные курса

Принимаемые параметры

Param	Type	Description
body	UpdateCourseDto	Тело запроса. См. UpdateCourseDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Обновлённый курс

---

Archive(id) ⇒ Promise.<ApiResult>

Меняет статус курса на архивный

Принимаемые параметры

Param	Type	Description
id	number	ID курса

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции

---

GetModules(courseId) ⇒ Promise.<ApiResult>

Получает список модулей курса

Принимаемые параметры

Param	Type	Description
courseId	number	ID курса

Возвращаемые данные

Returns: Promise.<ApiResult> - Список модулей курса

---

GetModuleById(courseId, moduleId) ⇒ Promise.<ApiResult>

Получает модуль по идентификатору

Принимаемые параметры

Param	Type	Description
courseId	number	ID курса
moduleId	number	ID модуля

Возвращаемые данные

Returns: Promise.<ApiResult> - Данные модуля

---

CreateModule(courseId, moduleData) ⇒ Promise.<ApiResult>

Создаёт модуль в курсе

Принимаемые параметры

Param	Type	Description
courseId	number	ID курса
moduleData	CreateModuleDto	Данные модуля. См. CreateModuleDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Созданный модуль

---

UpdateModule(courseId, moduleId, moduleData) ⇒ Promise.<ApiResult>

Обновляет данные модуля

Принимаемые параметры

Param	Type	Description
courseId	number	ID курса
moduleId	number	ID модуля
moduleData	UpdateModuleDto	Данные модуля. См. UpdateModuleDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Обновлённый модуль

---

DeleteModule(courseId, moduleId) ⇒ Promise.<ApiResult>

Удаляет модуль из курса

Принимаемые параметры

Param	Type	Description
courseId	number	ID курса
moduleId	number	ID модуля

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции

---

ReorderModules(courseId, items) ⇒ Promise.<ApiResult>

Изменяет порядок модулей в курсе

Принимаемые параметры

Param	Type	Description
courseId	number	ID курса
items	Array.<ReorderItemDto>	Новый порядок модулей. См. ReorderItemDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции

---

ReorderSections(courseId, moduleId, items) ⇒ Promise.<ApiResult>

Изменяет порядок разделов в модуле

Принимаемые параметры

Param	Type	Description
courseId	number	ID курса
moduleId	number	ID модуля
items	Array.<ReorderItemDto>	Новый порядок разделов. См. ReorderItemDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции

---

GetSections(courseId, moduleId) ⇒ Promise.<ApiResult>

Получает список разделов модуля

Принимаемые параметры

Param	Type	Description
courseId	number	ID курса
moduleId	number	ID модуля

Возвращаемые данные

Returns: Promise.<ApiResult> - Список разделов модуля

---

OpenSection(sectionId) ⇒ Promise.<ApiResult>

Открывает раздел для прохождения

Принимаемые параметры

Param	Type	Description
sectionId	number	ID раздела

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции

---

CompleteSection(sectionId) ⇒ Promise.<ApiResult>

Отмечает раздел как пройденный

Принимаемые параметры

Param	Type	Description
sectionId	number	ID раздела

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции

---

CreateSection(courseId, moduleId, sectionData) ⇒ Promise.<ApiResult>

Создаёт раздел в модуле курса

Принимаемые параметры

Param	Type	Description
courseId	number	ID курса
moduleId	number	ID модуля
sectionData	CreateSectionDto	Данные раздела. См. CreateSectionDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Созданный раздел

---

UpdateSection(courseId, moduleId, sectionId, sectionData) ⇒ Promise.<ApiResult>

Обновляет данные раздела

Принимаемые параметры

Param	Type	Description
courseId	number	ID курса
moduleId	number	ID модуля
sectionId	number	ID раздела
sectionData	UpdateSectionDto	Данные раздела. См. UpdateSectionDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Обновлённый раздел

---

DeleteSection(courseId, moduleId, sectionId) ⇒ Promise.<ApiResult>

Удаляет раздел из модуля

Принимаемые параметры

Param	Type	Description
courseId	number	ID курса
moduleId	number	ID модуля
sectionId	number	ID раздела

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции

---