Plan API

API przyjmuje i zwraca dane w postaci obiektów JSON. Niebieską ramką otoczone są dane wejściowe. W przypadku poprawnego wyniku zwrócony zostanie obiekt w postaci:

status
string
status == "ok"
result
{object|object[]}
wynik zapytania

Obiekt result będący wynikiem zapytania jest opisany w zielonej ramce dla wszystkich dostępnych przypadków.

W przypadku błędnego zapytania zwracany jest wynik w postaci:

status
string
status == "error"
error
string
opis błędu

Zwracane są jedynie roczniki i prowadzący mający zajęcia (przypisane, nie muszą być zaplanowane) w bieżącym semestrze.

GET api/activity
id
int
id aktywności
id
int
id aktywności
subject_id
int
id przedmiotu
subject
nazwa przedmiotu
id najniższej w hierarchii jednostki organizacyjnej
event_array
object[]
tablica wydarzeń w ramach aktywności
id
int
id wydarzenia
weekday
int
dzień tygodnia: 0 - niezaplanowane, 1 - poniedziałek, ..., 7 - niedziela
start_time
string
godzina rozpoczęcia (hh:mm)
length
string
czas trwania zajęć z wyłączeniem przerwy (hh:mm)
break_length
string
czas przerwy w ramach zajęć (hh:mm)
end_time
string
start_time + length + break_length (hh:mm)
room_id
int
id sali
room
string
nazwa sali
students_count
int
liczebność tablicy studentów
students_array
object[]
tablica przypisanych roczników
id
int
id rocznika
name
string
nazwa rocznika
group
int
grupa rocznika przypisana do aktywności, indeksowana od 1
groups
int
liczba wszystkich grup tego rocznika w tej aktywności
students_count
int
liczebność tablicy studentów
teacher_array
object[]
tablica przypisanych nauczycieli
id
int
id nauczyciela
name
string
tytuł, imię i nazwisko nauczyciela
teacher_count
int
liczebność tablicy nauczycieli
GET api/activity_list_for_room
id
int
id sali
count
int
liczebność tablicy wyników
array
object[]
tablica obiektów jak w api/activity
GET api/activity_list_for_students
id
int
id rocznika
count
int
liczebność tablicy wyników
array
object[]
tablica obiektów jak w api/activity
GET api/activity_list_for_teacher
id
int
id nauczyciela
count
int
liczebność tablicy wyników
array
object[]
tablica obiektów jak w api/activity
GET api/room
id
int
id sali
id
int
id sali
name
string
nazwa
department_id
int
id najniższej w hierarchii jednostki organizacyjnej
quantity
int
pojemność
GET api/room_list
id
int[]
(opcjonalny) tablica id sal; jeżeli pominięty, pobiera wszystkie sale
count
int
liczebność tablicy wyników
array
object[]
tablica obiektów jak w api/room
GET api/students
id
int
id rocznika
id
int
id rocznika
name
string
nazwa
GET api/students_list
id
int[]
(opcjonalny) tablica id roczników; jeżeli pominięty, pobiera wszystkie roczniki
count
int
liczebność tablicy wyników
array
object[]
tablica obiektów jak w api/students
GET api/teacher
id
int
id nauczyciela
id
int
id nauczyciela
degree
string
stopień/tytuł naukowy
department
int
id najniższej w hierarchii jednostki organizacyjnej
first_name
string
imię
last_name
string
nazwisko
GET api/teacher_list
id
int[]
(opcjonalny) tablica id nauczycieli; jeżeli pominięty, pobiera wszystkich nauczycieli
count
int
liczebność tablicy wyników
array
object[]
tablica obiektów jak w api/teacher
GET api/legacy/*

Zwraca plik XML w postaci zgodnej z planem działającym w latach 2012-2019. Id rocznika przekazany w url.