backend/docs/api.md

2.5 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
/getCourses Zwróenie wszystkich kursów

config

Source code: link

POST /config

Opis

Endpoint konfigurujacy caly system i importujacy dane do bazy.

Parametry

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

getcourseswithgroups

Source code: link

GET /getCoursesWithGroups

Opis

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

getcoursegroups

Source code: link

GET /getCourseGroups

Opis

Endpoint konfigurujacy caly system i importujacy dane do bazy.

Parametry

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

getcourses

Source code: link

GET /getCourses

Opis

Zwraca wszystkie dostepne kursy.

getCourseGroups

Source code: link

GET /getCourse

Opis

Endpoint konfigurujacy caly system i importujacy dane do bazy.