backend/docs/api.md
2020-09-22 18:00:28 +02:00

3.3 KiB
Executable File

Dokumetacja API

Api Zadania endpointa
/api/v1/configurator/config Załadowanie konfiguracji startowej do aplikacji PlanNaPlan
/api/v1/courses/getCoursesWithGroups Zwrócenie wszytskich kursów razem z grupami
/api/v1/groups/getCourseGroups Zwrócenie grup dla danego kursu
/api/v1/courses/getCourses Zwrócenie wszystkich kursów
/token Wymienia ticket z CAS-a na token ktorym beda autoryzowane chronione requesty

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 /api/v1/courses/getCoursesWithGroups

Opis

Zwraca wszystkie dostepne kursy wraz z listą grup.

getCourseGroups

Source code: link

GET /api/v1/groups/getCourseGroups

Opis

Zwraca wszytskie grupy dla danego kursu.

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 /api/v1/courses/getCourses

Opis

Zwraca wszystkie dostepne kursy.

token

Source code: link

GET /token?ticket=ST-668405-W0gfvSVDRBdMUWLweKzv-cas.amu.edu.pl

Opis

Po odpytaniu tego endpointa z podanym ticketem system zrobi nma nim validate i dostanie uzytkownika dla ktorego zostal on wygenerowany. System utworzy dla niego access token i go zwroci w odpowiedzi

Parametry

Type Name Consumes Opis Type
Query Param ticket
required
- ticket uzyskany z logowania poprzez CAS string