backend/docs/api.md
Filip Izydorczyk 2f42abff77 Added docs
2020-08-25 16:40:51 +02:00

2.0 KiB

Dokumetacja API

Api Zadania tej klasy
/config Załadowanie konfiguracji startowej do aplikacji PlanNaPlan
/getCoursesWithGroups Zwrócenie wszytskich kursów (ćwiczenia, wykłady) razem z grupami
/getCourseGroups Zwrócenie grup dla danego kursu

config

Source code: link

POST /config

Description

Endpoint konfigurujacy caly system i importujacy dane do bazy.

Parameters

Type Name Consumes Description Type
Body file
required
multipart/form-data Plik .xlsx z potrzebnymi danymi file

getCoursesWithGroups

Source code: link

GET /getCoursesWithGroups

Description

Zwraca wszystkie dostepne kursy wraz z lista grup dla poszczegolnych kursow.

getCourseGroups

Source code: link

GET /getCourseGroups

Description

Endpoint konfigurujacy caly system i importujacy dane do bazy.

Parameters

Type Name Consumes Description Type
Query Param id
required
- id kursu dla ktorego chcemy zwrocic grupy int
Query Param capacity
- czy ma zwrocic pole pojemnosci grupy bool