backend/docs/api.md

82 lines
2.5 KiB
Markdown
Raw Normal View History

2020-08-25 16:40:51 +02:00
# Dokumetacja API
2020-08-28 16:02:33 +02:00
| Api | Zadania tej klasy |
2020-08-25 16:40:51 +02:00
| ---------------------------------------------- | ---------------------------------------------------------------- |
| [/config](#config) | Załadowanie konfiguracji startowej do aplikacji PlanNaPlan |
2020-08-28 16:02:33 +02:00
| [/getCoursesWithGroups](#getcourseswithgroups) | Zwrócenie wszytskich kursów (ćwiczenia, wykłady) razem z grupami |
| [/getCourseGroups](#getcoursegroups) | Zwrócenie grup dla danego kursu |
| [/getCourses](#getcourses) | Zwróenie wszystkich kursów |
2020-08-25 16:40:51 +02:00
## config
Source code: [link](../restservice/src/main/java/com/plannaplan/controllers/ConfigController.java)
```
POST /config
```
2020-08-28 16:02:33 +02:00
#### Opis
2020-08-25 16:40:51 +02:00
Endpoint konfigurujacy caly system i importujacy dane do bazy.
2020-08-28 16:03:15 +02:00
#### Parametry
2020-08-25 16:40:51 +02:00
2020-08-28 16:02:33 +02:00
| Type | Name | Consumes | Opis | Type |
2020-08-25 16:40:51 +02:00
| ---- | ----------------------- | ------------------- | ------------------------------- | ---- |
| Body | **file** </br> required | multipart/form-data | Plik .xlsx z potrzebnymi danymi | file |
2020-08-28 16:02:33 +02:00
## getcourseswithgroups
2020-08-25 16:40:51 +02:00
Source code: [link](../restservice/src/main/java/com/plannaplan/controllers/getCoursesWithGroups.java)
```
GET /getCoursesWithGroups
```
2020-08-28 16:02:33 +02:00
#### Opis
2020-08-25 16:40:51 +02:00
Zwraca wszystkie dostepne kursy wraz z lista grup dla poszczegolnych kursow.
2020-08-28 16:02:33 +02:00
## getcoursegroups
2020-08-25 16:40:51 +02:00
Source code: [link](../restservice/src/main/java/com/plannaplan/controllers/GroupController.java)
```
GET /getCourseGroups
```
2020-08-28 16:02:33 +02:00
#### Opis
2020-08-25 16:40:51 +02:00
Endpoint konfigurujacy caly system i importujacy dane do bazy.
2020-08-28 16:03:15 +02:00
#### Parametry
2020-08-25 16:40:51 +02:00
2020-08-28 16:02:33 +02:00
| Type | Name | Consumes | Opis | Type |
2020-08-25 16:40:51 +02:00
| ----------- | --------------------- | -------- | ----------------------------------------- | ---- |
| Query Param | **id** </br> required | - | id kursu dla ktorego chcemy zwrocic grupy | int |
| Query Param | **capacity** </br> | - | czy ma zwrocic pole pojemnosci grupy | bool |
2020-08-28 16:02:33 +02:00
## getcourses
Source code: [link](../restservice/src/main/java/com/plannaplan/controllers/getCoursesWithGroups.java)
```
GET /getCourses
```
#### Opis
Zwraca wszystkie dostepne kursy.
## getCourseGroups
Source code: [link](../restservice/src/main/java/com/plannaplan/controllers/GroupController.java)
```
GET /getCourse
```
#### Opis
Endpoint konfigurujacy caly system i importujacy dane do bazy.